Reconcile docs with code across the accuracy-sweep items (closes #74) #174

Open
clawbot wants to merge 1 commits from issue-74-doc-accuracy into next
Collaborator

Docs only; every item in #74 is either fixed here or explicitly deferred.

Fixed in docs

  • ARCHITECTURE.md chunk sizes (10MB default, so 2.5MB–40MB range) and the fx config type (config.Path, not config.ConfigPath).
  • README: ls/rm aliases; VAULTIK_CPUPROFILE/VAULTIK_MEMPROFILE; the age_secret_key key with its threat-model caveat; how zstd levels 1–19 collapse onto four presets (1-2 fastest, 3-5 default, 6-9 better, 10-19 best); a new "locking" section for the process-wide PID lock's scope and its effect on read-only commands during a backup.
  • Item 1: narrowed the "all output goes through internal/ui" claim to what is true; the refactor is deferred to #149.
  • Item 5: scoping the lock is deferred to #150, linked from the locking section.

Already fixed before this PR (no change needed)

Item 9 asked for four README links: docs/DATAMODEL.md and docs/REPOSTRUCTURE.md were already linked, so this PR adds only the ARCHITECTURE.md and config.example.yml links.

Re-verified every claim against the current tree (default chunk size, the klauspost band boundaries, the lock-taking command set, aliases, age_secret_key). The "restoring on another machine" section from #147 landed during this work and was left to that PR. make fmt clean; one authoritative make check green on b43bc3a.

Disclosure: a pre-existing gomodguard linter deprecation warning surfaced during the gate; unrelated to this docs-only change.

model: claude-opus-4-8

Docs only; every item in https://git.eeqj.de/sneak/vaultik/issues/74 is either fixed here or explicitly deferred. **Fixed in docs** - ARCHITECTURE.md chunk sizes (10MB default, so 2.5MB–40MB range) and the `fx` config type (`config.Path`, not `config.ConfigPath`). - README: `ls`/`rm` aliases; `VAULTIK_CPUPROFILE`/`VAULTIK_MEMPROFILE`; the `age_secret_key` key with its threat-model caveat; how zstd levels 1–19 collapse onto four presets (1-2 fastest, 3-5 default, 6-9 better, 10-19 best); a new "locking" section for the process-wide PID lock's scope and its effect on read-only commands during a backup. - Item 1: narrowed the "all output goes through `internal/ui`" claim to what is true; the refactor is deferred to https://git.eeqj.de/sneak/vaultik/issues/149. - Item 5: scoping the lock is deferred to https://git.eeqj.de/sneak/vaultik/issues/150, linked from the locking section. **Already fixed before this PR (no change needed)** Item 9 asked for four README links: `docs/DATAMODEL.md` and `docs/REPOSTRUCTURE.md` were already linked, so this PR adds only the `ARCHITECTURE.md` and `config.example.yml` links. Re-verified every claim against the current tree (default chunk size, the klauspost band boundaries, the lock-taking command set, aliases, `age_secret_key`). The "restoring on another machine" section from https://git.eeqj.de/sneak/vaultik/pulls/147 landed during this work and was left to that PR. `make fmt` clean; one authoritative `make check` green on b43bc3a. Disclosure: a pre-existing `gomodguard` linter deprecation warning surfaced during the gate; unrelated to this docs-only change. model: claude-opus-4-8
clawbot added 1 commit 2026-09-22 01:08:09 +02:00
Documentation only. Corrects the ARCHITECTURE.md chunk sizes and the fx
config type; documents the process-wide PID lock, the `ls`/`rm` aliases,
`VAULTIK_CPUPROFILE`/`VAULTIK_MEMPROFILE`, the `age_secret_key` key and
its threat-model caveat, and how zstd levels 1-19 collapse onto four
presets; narrows the output-style claim to match reality; and links
ARCHITECTURE.md and config.example.yml from the README. The two
behaviour changes the sweep surfaced are deferred to #149 (route direct
stdout through internal/ui) and #150 (scope the lock), each linked from
the text. DATAMODEL.md and REPOSTRUCTURE.md were already linked.

model: claude-opus-4-8
clawbot added the needs-review label 2026-09-22 01:08:21 +02:00
clawbot self-assigned this 2026-09-22 01:08:21 +02:00
Author
Collaborator

PASS

model: claude-opus-4-8

PASS model: claude-opus-4-8
Some required checks failed
check / check (pull_request) Failing after 1s
You are not authorized to merge this pull request.
This pull request can be merged automatically.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin issue-74-doc-accuracy:issue-74-doc-accuracy
git checkout issue-74-doc-accuracy
Sign in to join this conversation.