Skip to content

docs: add documentation and licensing - #8

Merged
nozaq merged 1 commit into
mainfrom
claude/readme-creation-improvement-9gpgx8
Aug 12, 2026
Merged

docs: add documentation and licensing#8
nozaq merged 1 commit into
mainfrom
claude/readme-creation-improvement-9gpgx8

Conversation

@nozaq

@nozaq nozaq commented Aug 11, 2026

Copy link
Copy Markdown
Member

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:

  • Features — one table carrying everything per-feature: what you get, and where it comes from and how it is verified.
  • Why these features — the goals: minimal trusted upstreams, trusted material reviewed in this repository, self-contained installs, minimal images staying minimal, and rebuilds staying cheap.
  • Quick start — adding a feature, and passing options.
  • Versions and pinning — the four tags each release publishes and which of them move.
  • Supply chain — what a reader is trusting, what can be inspected before pinning, how the trusted material changes, and what is not covered (no provenance attestation or SBOM).
  • Testing, Related repositories, Contributing, Security, License.

Feature documentation

src/*/NOTES.md reworked 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.md regenerated with devcontainer features generate-docs (CLI 0.88.0, the version CI pins); running it again is a no-op.

devcontainer-feature.json is untouched, so no feature version bump or republish is needed.

https://claude.ai/code/session_01Li88NWapAE1Uy9SKoEtCyF

@nozaq nozaq changed the title Add comprehensive documentation and licensing docs: add comprehensive documentation and licensing Aug 12, 2026
@nozaq nozaq changed the title docs: add comprehensive documentation and licensing docs: add documentation and licensing Aug 12, 2026
@nozaq nozaq closed this Aug 12, 2026
@nozaq
nozaq force-pushed the claude/readme-creation-improvement-9gpgx8 branch from dd625bd to c5b3f9e Compare August 12, 2026 01:35
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
@nozaq nozaq reopened this Aug 12, 2026
@nozaq
nozaq merged commit 37a6f00 into main Aug 12, 2026
8 checks passed
@nozaq
nozaq deleted the claude/readme-creation-improvement-9gpgx8 branch August 12, 2026 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants