Restructure README and move technical guides into docs#3
Merged
Conversation
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
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.
What changed
docs/host/README*point to the canonical getting-started guidesWhy
The root README had grown to roughly 500 lines, placing usage behind a long installation section and duplicating version-sensitive commands. This keeps the project landing page task-oriented while preserving exact commands and contracts in versioned repository documentation.
GitHub Wiki content is prepared separately for navigation, FAQ, and field debugging. It will be published after this PR reaches
mainso its canonicalblob/mainlinks do not return 404.User and developer impact
host/README*Validation
python3 -m unittest discover -s tools -p 'test_*.py'— 167 passednode tools/test_stackchan_mod_web_behavior.mjs— passedgit diff --check— passed