docs: add Diátaxis documentation types to README standards - #39
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
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.
Problem
The README standards cover README structure only. There is no rule for pages beyond the README, so repos that outgrow it end up with flat
docs/folders that mix user guides, API facts, design notes, and working plans (wlanpi-core,wlanpi-mcp,wlanpi-profiler, and others).Change
Adds a Documentation Types section to
style/README_STANDARDS.mdbased on Diátaxis:docs/{tutorials,how-to,reference,explanation}/, creating only the folders that have pages.REPOS.mdrecords that no repo uses the layout yet and lists the six with ad-hocdocs/folders.No existing repo has to change now.
Validation
shellcheck install.sh: passactionlint: pass