Skip to content

docs: update documentation, architecture and threat model in the book - #705

Merged
vyskocilm merged 2 commits into
mainfrom
docs/book-architecture
Oct 26, 2026
Merged

vyskocilm merged 2 commits into
mainfrom
docs/book-architecture

Conversation

@vyskocilm

@vyskocilm vyskocilm commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Update documentation.

  • docs/src/architecture.md: process shapes moved from README, plus Go without cgo, single-threaded setns, what dies when
  • docs/src/threat-model.md: two goals, what snug does not defend against
  • SUMMARY.md: both pages after Claude Code
  • README.md: drop dead link to docs/src/requirements.md (never landed; snug doctor covers it)
  • book_test.go / docexamples_test.go: fence records its language; TestBookHasNoMultiLineInlineTable skips go fences (architecture.md has Go snippet). docexamples_test no longer reads README.md
  • doctorgetent_test.go: comment no longer cites README Requirements
  • ENGINE-WIRING.md:433 cites architecture.md "What dies when" instead of README

Two commits: Go test changes, then docs. Same tree as the make gate green checkout, rebased on main c9f9480.

🤖 Generated with Claude Code

@vyskocilm vyskocilm changed the title docs: architecture and threat model pages in the book docs: update documentation, architecture and threat model in the book Oct 26, 2026
@vyskocilm
vyskocilm marked this pull request as ready for review October 26, 2026 19:50
vyskocilm and others added 2 commits October 26, 2026 20:51
A fence records its language, and TestBookHasNoMultiLineInlineTable skips
go fences, since a Go snippet is not TOML. docexamples_test no longer reads
README.md, the book is the user reference now. The getent test comment no
longer cites the README Requirements section.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Architecture and threat model move from the README to the book. The README
drops its dead requirements link.
@vyskocilm
vyskocilm force-pushed the docs/book-architecture branch from 5abc0af to 4c87e7b Compare October 26, 2026 19:52
@vyskocilm
vyskocilm merged commit 904edeb into main Oct 26, 2026
5 checks passed
@vyskocilm
vyskocilm deleted the docs/book-architecture branch October 26, 2026 20:02
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