docs: add documentation and licensing - #8
Merged
Conversation
nozaq
force-pushed
the
claude/readme-creation-improvement-9gpgx8
branch
from
August 12, 2026 01:35
dd625bd to
c5b3f9e
Compare
The repository had no README, so a visitor could not tell what it publishes, who it is for, or how it relates to the images and templates repositories. Add one that opens with the feature list and the goals behind them, then covers usage, the tags each release publishes, what a reader is trusting and can verify, and how the features are tested. Rework each feature's NOTES.md into the same section order — requirements, usage, installed software, what is left out, supply chain, tips — and regenerate the feature READMEs from them. Add the MIT license and a security policy the README links to. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Li88NWapAE1Uy9SKoEtCyF
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.
Adds the repository README, licensing and security policy, and reworks the per-feature documentation.
Summary
The repository had no README, so a visitor could not tell what it publishes, who it is for, or how it relates to the images and templates repositories. This adds one, plus the MIT license and security policy it links to, and brings the feature documentation into a consistent shape.
README.md
Ordered for a reader arriving with no prior context:
Feature documentation
src/*/NOTES.mdreworked into the same section order — requirements, usage, installed software, what is left out, supply chain, tips — with the key inspection command next to the key it inspects.src/*/README.mdregenerated withdevcontainer features generate-docs(CLI 0.88.0, the version CI pins); running it again is a no-op.devcontainer-feature.jsonis untouched, so no feature version bump or republish is needed.https://claude.ai/code/session_01Li88NWapAE1Uy9SKoEtCyF