Reconcile the schema/migration docs with the code (closes #68) #146

Merged
clawbot merged 1 commits from issue-68-schema-migration-docs into next 2026-09-21 21:58:37 +02:00
Collaborator

Docs-only reconciliation of the schema/migration story with the code
(#68).

What changed

  • docs/DATAMODEL.md now owns the explanation. It separates the unchanged
    policy (no supported upgrade path between versions — delete the local index
    with vaultik database delete and re-back-up) from the schema bootstrap
    that does exist: numbered files in internal/database/schema/ (000.sql
    creates the schema_migrations table, 001.sql the application tables),
    applied to a fresh database and recorded in schema_migrations.
  • README.md (the caveat and the roadmap entry) and AGENTS.md are reworded
    to match and link to docs/DATAMODEL.md. AGENTS.md now names the real file
    to edit (internal/database/schema/001.sql) instead of the nonexistent
    schema.sql, and notes the pre-1.0 disposability clause expires on tagging,
    so the upgrade question returns at release.

No document asserts the schema_migrations table is absent. Policy unchanged;
no code changed.

Disclosures

  • Judgement call: schema.sql still appears as a substring in two files I did
    not touch. REPO_POLICIES.md names 001_schema.sql, but it is cross-project
    policy marked "kept in sync with the authoritative source" — editing it would
    change org-wide policy, out of scope. internal/database/database_test.go
    uses schema.sql as an invalid-filename test fixture; done-item 6 restricts
    this change to docs only. I read done-item 1's "anywhere" as the
    contributor-facing prose that misdirects, which item 6 makes the only
    reachable scope.

model: claude-opus-4-8

Docs-only reconciliation of the schema/migration story with the code (https://git.eeqj.de/sneak/vaultik/issues/68). ## What changed - `docs/DATAMODEL.md` now owns the explanation. It separates the unchanged policy (no supported upgrade path between versions — delete the local index with `vaultik database delete` and re-back-up) from the schema *bootstrap* that does exist: numbered files in `internal/database/schema/` (`000.sql` creates the `schema_migrations` table, `001.sql` the application tables), applied to a fresh database and recorded in `schema_migrations`. - `README.md` (the caveat and the roadmap entry) and `AGENTS.md` are reworded to match and link to `docs/DATAMODEL.md`. `AGENTS.md` now names the real file to edit (`internal/database/schema/001.sql`) instead of the nonexistent `schema.sql`, and notes the pre-1.0 disposability clause expires on tagging, so the upgrade question returns at release. No document asserts the `schema_migrations` table is absent. Policy unchanged; no code changed. ## Disclosures - Judgement call: `schema.sql` still appears as a substring in two files I did not touch. `REPO_POLICIES.md` names `001_schema.sql`, but it is cross-project policy marked "kept in sync with the authoritative source" — editing it would change org-wide policy, out of scope. `internal/database/database_test.go` uses `schema.sql` as an invalid-filename test fixture; done-item 6 restricts this change to docs only. I read done-item 1's "anywhere" as the contributor-facing prose that misdirects, which item 6 makes the only reachable scope. model: claude-opus-4-8
clawbot added 1 commit 2026-09-21 21:34:48 +02:00
Reconcile the schema/migration docs with the code (closes #68)
check / check (pull_request) Successful in 3m0s
14e0592c9a
Four documents implied vaultik has no schema-application mechanism and
told contributors to edit a nonexistent `schema.sql`. The code does have
numbered files in `internal/database/schema/` (`000.sql` creates the
`schema_migrations` table, `001.sql` the application tables) that
bootstrap a fresh database.

docs/DATAMODEL.md now owns the explanation, distinguishing the unchanged
policy (no upgrade path between versions; delete the local index and
re-back-up) from the bootstrap mechanism that does exist. README (caveat
and roadmap) and AGENTS.md are reworded to match and link there. AGENTS.md
now names the real file to edit and notes that the pre-1.0 disposability
clause expires on tagging.

Policy is unchanged; docs only.

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

PASS

model: claude-opus-4-8

PASS model: claude-opus-4-8
clawbot merged commit aab6a87f8c into next 2026-09-21 21:58:37 +02:00
clawbot deleted branch issue-68-schema-migration-docs 2026-09-21 21:58:37 +02:00
Sign in to join this conversation.