docs: add root architecture reference - #164
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 02a68b30a5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Writes use a new owner-only temporary file followed by atomic rename. In-memory | ||
| state is rolled back if persistence fails. |
There was a problem hiding this comment.
Correct the state rollback guarantee
When saving a newly created, rotated, or started backend session fails, Store::session_for, Store::rotate, and Store::mark_started have already mutated self.state and do not restore its previous value; only set_cursor implements rollback. A subsequent message in the same process can therefore observe session state that was never persisted, contrary to this architecture guarantee. Narrow the statement to cursor writes or add rollback to the session mutations.
Useful? React with 👍 / 👎.
Summary
Replace the older docs-site architecture page with one root
ARCHITECTURE.mdmodeled on Block Buzz’s numbered architecture reference. The new source covers runtime boundaries, process and message lifecycles, channels, agent adapters, durable data, jobs, concurrency, security, recovery, source ownership, and verification. Repository and docs-site navigation now point to that single source of truth.Why
The architecture reference should be visible from the repository root, comprehensive enough to guide changes, and maintained in one place. Root documentation links are now included in the existing documentation link test.
Test plan
cargo fmt --all --checkcargo clippy --locked --all-targets -- -D warningscargo build --lockedcargo test --locked(367 tests passed)bash tests/install.shbash tests/release-version.shmkdocs build --strictin a temporary environment fromrequirements-docs.txtARCHITECTURE.mdremainsRisks
Low. This is documentation and documentation-test coverage only. The main risk is architecture text drifting from implementation; source links and the expanded link test reduce navigation drift, while factual claims were checked against the current code.
Related issue
None.