docs: add plans/README.md documenting the plan-document convention (#753) - #918
docs: add plans/README.md documenting the plan-document convention (#753)#918chethanuk wants to merge 1 commit into
Conversation
`plans/` holds 16 directories and no top-level file, so the only written statement of the convention is one clause in CONTRIBUTING.md. That clause is already narrower than the tree it governs — three directories are named workstreams rather than issue numbers, and two key off a PR number — and AGENTS.md, the agent entry point, never mentions plans at all. Add plans/README.md covering what the directory is (development planning artifacts, never published to the docs site), the plans/ vs architecture/ vs fern/ vs docs/ boundary, both live naming conventions, the document shape as observed, where assets go, and how a plans-only PR is reviewed per .agents/recipes/pr-review/recipe.md. Point AGENTS.md at it with one line, matching the three sentences already there. CONTRIBUTING.md is deliberately unchanged: GitHub renders a directory's README.md, so its relative link and the Fern copy's absolute one both land on the new file without an edit. Refs NVIDIA-NeMo#753 Signed-off-by: ChethanUK <chethanuk@outlook.com>
|
Thank you for your submission! We ask that you sign our Developer Certificate of Origin before we can accept your contribution. You can sign the DCO by adding a comment below using this text: I have read the DCO document and I hereby sign the DCO. You can retrigger this bot by commenting recheck in this Pull Request. Posted by the DCO Assistant Lite bot. |
Linked Issue CheckIssue #753 has not been triaged yet. A maintainer needs to review You can continue working on the PR in the meantime. The check will |
Greptile SummaryThis documentation-only PR establishes a top-level guide for development plans and makes it discoverable from the agent entry point.
|
| Filename | Overview |
|---|---|
| AGENTS.md | Adds a valid link directing development agents to the new planning convention. |
| plans/README.md | Documents repository planning conventions with accurate paths, examples, workflow behavior, and review guidance. |
Reviews (1): Last reviewed commit: "docs: add plans/README.md documenting th..." | Re-trigger Greptile
📋 Summary
plans/has 16 directories and no top-level file explaining what they are, so the only writtenstatement of the convention is one clause in
CONTRIBUTING.md("create a plan document atplans/<issue-number>/") — already narrower than the tree it governs, and never mentioned inAGENTS.md, the agent entry point. Addsplans/README.mddocumenting the structure as itactually exists, and points
AGENTS.mdat it.🔗 Related Issue
Closes #753
🔄 Changes
plans/README.md: what the directory is (development planning artifacts, neverpublished to the docs site), the
plans/vsarchitecture/vsfern/vsdocs/boundary,both live naming conventions (
plans/<issue-number>/andplans/<workstream-name>/), thedocument shape as observed, where assets go, and how a plans-only PR is reviewed per
.agents/recipes/pr-review/recipe.md.AGENTS.mdpointing atplans/, matching the three sentences already there.CONTRIBUTING.mdis intentionally unchanged — GitHub renders a directory'sREADME.md, soits existing relative link (and the Fern copy's absolute one) already land on the new file.
🧪 Testing
make test— N/A, documentation-only changeplans/has no testcoverage and the repo has no markdown linter
uvx pre-commit run --files plans/README.md AGENTS.mdpasses (trailing-whitespace,end-of-file-fixer, mixed-line-ending)
plans/README.mdresolved by hand againstgit ls-tree origin/main plans/✅ Checklist
architecture/