Repository navigation
Explain repository folders and files in plain language - #3
Merged
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
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.
GitHub's folder/file list shows the latest commit message for each path, so a change affecting many paths repeats the same message. Readers need a separate guide explaining what those paths actually contain.
Replace the README's jargon-heavy directory tree with a linked table of folder purposes. Add one file guide covering every tracked file, with plain descriptions and links to its source. Explain the commit-message column in that guide. Add the guide to the public release allowlist.
Validation: guide coverage checked against all 65 tracked files; all local links in README/guide resolve; lint, formatting, whitespace and release-content checks pass. No engine, helper or test implementation changes.