Skip to content

Commit 3a67bb6

Browse files
committed
Point to the repos needed for top-of-tree DocC.
1 parent ebdff46 commit 3a67bb6

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

bin/update-book-preview

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,14 @@
1414
# This script should be run by someone with commit access to the 'gh-pages' branch
1515
# at a regular frequency so that the documentation content on the GitHub Pages site
1616
# is up-to-date with the content in this repo.
17-
18-
# To use top-of-tree DocC, set environment variables like the following:
17+
#
18+
# To use top-of-tree DocC, clone the following repositories:
19+
#
20+
# https://github.com/apple/swift-docc
21+
# https://github.com/apple/swift-docc-render
22+
#
23+
# Then set environment variables to paths in their working directories,
24+
# like the following, before running this script:
1925
#
2026
# DOCC_EXEC=~/git/DocC/.build/arm64-apple-macosx/debug/docc
2127
# DOCC_HTML_DIR=~/git/DocC-Renderer/dist/

0 commit comments

Comments
 (0)