Skip to content

Commit 3b3df19

Browse files
committed
Add stub troubleshooting guide
1 parent ae941d6 commit 3b3df19

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

.jazzy.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ custom_categories:
1818
- Tweak Preferences
1919
- Orion Directives
2020
- Using Orion Without Theos
21+
- Troubleshooting
2122
- name: Class Hooking
2223
children:
2324
- ClassHook

Guides/Troubleshooting.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Troubleshooting
2+
3+
(TODO)

generate-docs.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ elif [[ $# = 2 ]]; then
1818
perma_args=(--module-version "${version}" --github-file-prefix "${file_prefix}" --root-url "${root_url}versions/${version}/")
1919
outdir=".."
2020
else
21-
echo "Usage: $0 [cached|<<git hash> <version>>]" >&2
21+
echo "Usage: $0 [watch|cached|<<git hash> <version>>]" >&2
2222
exit 1
2323
fi
2424
common_args=(--head "$(cat head.html)" --separate-global-declarations --sourcekitten-sourcefile docs.json)
2525

2626
rm -rf "${outdir}/docs" "${outdir}/docs-perm"
2727

28-
# if $# = 1 then it's a cached build; use the existing docs.json
28+
# if it's a cached build, use the existing docs.json
2929
if [[ $# = 1 && $1 = "cached" ]]; then
3030
if [[ ! -r docs.json ]]; then
3131
echo "Error: You cannot perform a cached build without having normally generated the docs at least once." >&2

0 commit comments

Comments
 (0)