docs: publish the FAQ and troubleshooting guide in the docs tree - #64
Merged
Merged
Conversation
These answers existed only as wiki source under docs/wiki/, so nobody could read them: GitHub creates a wiki's git repository only when its first page is saved from a signed-in browser, and there is no API for that. The content was therefore gated behind a manual step that had not happened, and might never. They are now docs/FAQ.md and docs/TROUBLESHOOTING.md, linked from the README and the documentation index, rendered like every other page in the tree. Wiki link syntax and absolute blob URLs were rewritten as relative links; a link check over both new files, the docs index and the README reports none broken. docs/wiki/ and tool/publish_wiki.sh stay for whoever wants the wiki tab populated, and its README now says the content is mirrored rather than exclusive. Nothing is unreachable while the wiki stays empty.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The wiki's first page cannot be created without a signed-in browser — no API exists, and I tried every route. That left the FAQ and troubleshooting content unreadable by anyone, gated behind a manual step that might never happen.
So it no longer depends on the wiki.
What this does
docs/FAQ.mdanddocs/TROUBLESHOOTING.md, linked from the README's top nav and the documentation index, rendered on GitHub like every other page in the tree.Wiki
[[Page]]syntax and absolute blob URLs were rewritten as relative links. A link check over both new files, the docs index and the README reports none broken; the site verifier still passes at 11 links.The troubleshooting page is the one worth having — it documents the failures this project actually hit, including the
pgrep -ftrap that produced a confident CPU reading for the wrong process.The wiki still works if you want it
docs/wiki/andtool/publish_wiki.shremain. Its README now says the content is mirrored rather than exclusive, so the wiki tab is a nice-to-have rather than a blocker.