docs: add NOTES.md documentation and refresh template descriptions#67
Merged
Merged
Conversation
…saging Rewrite each template's description around the security-focused messaging introduced in the updated repository description and README intro, sync the root README templates table to the same strings, bump each template's patch version, and raise the CI description length limit from 80 to 88 characters. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LjtasUDz8tNuF7Nb1ZetRB
Document each template's security hardening, persistent cache volumes, editor integration, and usage tips. The release workflow's generate-docs step appends NOTES.md into the auto-generated per-template README.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LjtasUDz8tNuF7Nb1ZetRB
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 adds comprehensive NOTES.md documentation files to all dev container templates and updates their descriptions in devcontainer-template.json files to be more descriptive and consistent.
Key Changes
Added NOTES.md files to all 10 templates (bun, debian, golang, mise, node, rust, terraform, uv, zig) with:
Updated template descriptions in devcontainer-template.json files:
Updated template versions (patch bumps) across all templates to reflect documentation additions
Notable Details
https://claude.ai/code/session_01LjtasUDz8tNuF7Nb1ZetRB