docs: add root documentation convention with a worked example - #3
Merged
Merged
Conversation
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
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.
Summary
This PR establishes the root documentation convention (spec/acceptance/intent per module) with a worked example, adds a cross-agent
docs-reviewskill, and allows cross-agent agent config to be committed.What does this pull request change?
docs/README.md): when a module needsspec.md,acceptance.md, andintent.md, plus a worked example underdocs/example/docs-reviewskill under.agents/skills/for cross-agent doc review.agents/**in.gitignoreto allow committing cross-agent config (now cross-agent config can be versioned)BUILDING.md: the frontmatter exception now applies only to the rootREADME.md(module READMEs now require frontmatter), and rewrites the agents rule to reflect the change above**/*.mdin thepull-request.ymlworkflowHow to test?
docs-reviewskill againstdocs/example/and confirm it flags the worked example as compliant with the new conventionOther Notes and Links