Skip to content

docs: rewrite README, security model, and comparison page#14

Merged
chrisfentiman merged 2 commits into
mainfrom
docs/readme-security-comparisons
Mar 13, 2026
Merged

docs: rewrite README, security model, and comparison page#14
chrisfentiman merged 2 commits into
mainfrom
docs/readme-security-comparisons

Conversation

@chrisfentiman
Copy link
Copy Markdown
Owner

Summary

  • README.md — conventional structure with install methods, commands table, file layout, security summary, project-local mode docs, and detailed chezmoi comparison table
  • SECURITY.md — expanded threat model with trust boundary table, full subprocess environment allowlist, template injection prevention, and new attack surface documentation (DoS via .secrets.toml, side channels)
  • docs/index.html — comparison section rewritten with feature matrix table covering 7 tools and in-depth analysis with verdicts/tags for chezmoi, GNU Stow, yadm, dotbot, home-manager, git-crypt/git-secret, and rcm
  • Removed stale Handlebars references (now uses single-pass renderer)

Test plan

  • CI Gate passes (docs-only change, tests should be skipped)
  • After merge, GitHub Pages deploys the updated comparison page

🤖 Generated with Claude Code

Chris Fentiman and others added 2 commits March 13, 2026 16:59
README follows conventional structure with install, quick start,
commands table, file layout, security summary, and detailed
chezmoi comparison. SECURITY.md expanded with trust boundaries,
full threat model, subprocess allowlist, and new attack surfaces.
GitHub Pages comparison section adds feature matrix table and
in-depth analysis of 7 tools (chezmoi, Stow, yadm, dotbot,
home-manager, git-crypt, rcm) with verdicts and tags.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… pages

Expand --dir local mode into first-class documentation: dedicated
README section with example workflow and file layout, security
boundary docs in SECURITY.md, project-local column in comparison
matrices, and new section on GitHub Pages with use case and code
example.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@chrisfentiman chrisfentiman force-pushed the docs/readme-security-comparisons branch from 2575e55 to 3659426 Compare March 13, 2026 23:59
@chrisfentiman chrisfentiman merged commit 282f258 into main Mar 13, 2026
7 checks passed
@chrisfentiman chrisfentiman deleted the docs/readme-security-comparisons branch March 13, 2026 23:59
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.

1 participant