docs: reorganize README and improve template documentation structure - #108
Merged
Conversation
Reorder the repository README around what a first-time visitor asks: move the Templates table above Getting Started so the "which one do I pick" question is answered before the how-to, add prerequisites and the container-start step to Getting Started, and add a "What You Get" section showing the devcontainer.json a template actually produces and how it maps to the project goals. The "Getting Started" and "Pinning Images to a Digest" headings are kept verbatim: their anchors are referenced from every NOTES.md and from the devcontainer.json comments that get copied into user projects. Normalize the NOTES.md section order so "Usage Notes" precedes "Persistent Caches" in every template, and regenerate the affected README.md files. Document the canonical section order in AGENTS.md, along with the rule that each template page stays self-contained. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01C7BAYhNP7oaXcjP4qEVpGV
Switch the "What You Get" example from the Node.js template to uv. The uv image tag is the Debian codename alone, so it does not change when a new Python release ships, while node's tag carries the Node major version and would go stale on every bump. uv also configures customizations, so the example now covers all four goals rather than three. Drop the Docker prerequisite and stop implying that VS Code and the devcontainer CLI are the only options: these templates follow the Dev Container specification and work with any tool that supports it. The two subsections remain as concrete examples. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01C7BAYhNP7oaXcjP4qEVpGV
nozaq
changed the title
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
2 participants
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 reorganizes the main README to improve information architecture and establishes clearer documentation standards for individual templates. The changes make the repository more navigable for users while providing guidance for template maintainers.
Key Changes
devcontainer.jsonconfigurationAGENTS.mdwith clear guidelines for template README structure, including:NOTES.md(source) andREADME.md(generated)miseanduvtemplates (in bothNOTES.mdand generatedREADME.md) to follow the new recommended section orderNotable Details
devcontainer.jsonexample in the main README demonstrates how configuration maps to the stated goalshttps://claude.ai/code/session_01C7BAYhNP7oaXcjP4qEVpGV