📖 [Docs]: Repository READMEs are concise start pages#21
Open
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Open
📖 [Docs]: Repository READMEs are concise start pages#21Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
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.
Repository README defaults now define the README as a concise start page instead of a manual. The central standard explains the questions a README should answer, when product documentation belongs in
docs/and GitHub Pages, and when a fuller README is appropriate for GitHub Actions and reusable workflows.Changed: README defaults are framed as a start page
The repository standard now says a README should answer: what is it, why should I care, how do I get it, how does it work, and how do I get more information.
Changed: Product documentation ownership is explicit
The standard now distinguishes short README start pages from product documentation. PowerShell modules and similar products should keep deeper docs in
docs/and publish them, while GitHub Actions and reusable workflow repositories can use a fuller README because that is the expected interface documentation surface.Technical Details
src/docs/Ways-of-Working/Repository-Standard.md.