docs: sync docs with encrypted settings store (VA-33) #31

Merged

nrupard merged 1 commit from docs/encrypted-settings-store-VA-33 into main

2026-05-21 21:10:36 +02:00

nrupard commented

2026-05-21 21:05:53 +02:00

Owner

Documentation-only. Syncs the docs with the encrypted local-settings store that landed in VA-33 (PR #30, now on main). No code changes.

Why

VA-33 replaced the plaintext .msh config with an encrypted <stem>.vss store, but README/ROADMAP still described the old .msh surface, and the README linked to docs/local-settings-store.md, which only existed on the unmerged VA-29 branch (dangling link on main).

Changes

README: rewrote the --check and self-update bullets, the ServerID pinning note, and the local-data-store design decision to describe the encrypted .vss store and the sled identity store separately. Added a Configuration section covering --settings / --secret-file, the config show/get/set/seal subcommands, automatic .msh migration, and the install flow. Added settings to the listed library modules.
ROADMAP: corrected the crate count (5, adding vervain-agent-mcp) and recorded the VA-33 delta.
docs/local-settings-store.md: landed the design doc on main with its status flipped to implemented and an Implementation notes section reconciling what shipped against the plan (whole-file AEAD not SQLite, --settings is a directory, kept the .msh.template name, read-only --check). Original design body preserved as rationale.

Note

This supersedes PR #29 (the VA-29 design-doc deliverable): the same doc is included here with its status updated, so #29 can be closed.

Documentation-only. Syncs the docs with the encrypted local-settings store that landed in VA-33 (PR #30, now on main). No code changes. ## Why VA-33 replaced the plaintext `.msh` config with an encrypted `<stem>.vss` store, but README/ROADMAP still described the old `.msh` surface, and the README linked to `docs/local-settings-store.md`, which only existed on the unmerged VA-29 branch (dangling link on main). ## Changes - **README**: rewrote the `--check` and self-update bullets, the `ServerID` pinning note, and the local-data-store design decision to describe the encrypted `.vss` store and the sled identity store separately. Added a `Configuration` section covering `--settings` / `--secret-file`, the `config show/get/set/seal` subcommands, automatic `.msh` migration, and the install flow. Added `settings` to the listed library modules. - **ROADMAP**: corrected the crate count (5, adding `vervain-agent-mcp`) and recorded the VA-33 delta. - **docs/local-settings-store.md**: landed the design doc on main with its status flipped to implemented and an `Implementation notes` section reconciling what shipped against the plan (whole-file AEAD not SQLite, `--settings` is a directory, kept the `.msh.template` name, read-only `--check`). Original design body preserved as rationale. ## Note This supersedes PR #29 (the VA-29 design-doc deliverable): the same doc is included here with its status updated, so #29 can be closed.

nrupard added 1 commit

2026-05-21 21:05:53 +02:00

docs: sync README, ROADMAP, design doc with the encrypted settings store (VA-33)

Check / clippy + fmt + tests (pull_request) Failing after 48s

Details

a85eb3ae40

VA-33 (PR #30) landed the encrypted local-settings store but the docs still described the plaintext `.msh` config. This brings them in line with the shipped code.

README: rewrites the `--check` and self-update bullets, the `ServerID` pinning note, and the data-store design decision to describe the encrypted `<stem>.vss` store and the sled identity store separately. Adds a `Configuration` section documenting `--settings` / `--secret-file`, the `config show/get/set/seal` subcommands, automatic `.msh` migration, and the install flow. Adds `settings` to the listed library modules.

ROADMAP: corrects the crate count (5, adding `vervain-agent-mcp`) and records the VA-33 delta.

docs/local-settings-store.md: was the VA-29 design doc (never merged to main, which left the README link dangling). Lands it here with the status flipped to implemented and an `Implementation notes` section reconciling what shipped against the plan (whole-file AEAD not SQLite, `--settings` is a directory, kept the `.msh.template` name, read-only `--check`). The original design body is preserved as the rationale of record. Supersedes PR #29.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

nrupard force-pushed docs/encrypted-settings-store-VA-33 from a85eb3ae40

Check / clippy + fmt + tests (pull_request) Failing after 48s

Details

to c4078300f8

Check / clippy + fmt + tests (pull_request) Successful in 1m25s

Details

2026-05-21 21:07:56 +02:00

Compare