Skip to content

docs: README sections for plan/web/sql2hcl/dump-sql/dump-cluster; orphaned examples/manifest; stale CLAUDE.md lines; operational policies #97

Description

@orian

Symptom

Documentation lags the feature set and, in places, contradicts current policy:

  • plan, web, sql2hcl, dump-sql, dump-cluster have no dedicated README sections; dump-sql is absent from docs/README.hcl.md and docs/FAQ.md entirely.
  • docs/FAQ.md ("Worked examples") covers only diff/validate/drift/plan lightly.
  • examples/manifest/ — the flagship worked example for the manifest/plan/web -manifest features, with its own README — is referenced by no top-level doc (only examples/exclude.hcl is linked).
  • CLAUDE.md:137 says view/dictionary blocks are "planned, not implemented" while two other lines in the same file (and the code) say they are fully implemented; CLAUDE.md:104 still references the removed "YAML -> Diff -> Apply" flow.
  • Operational policies are undocumented: DDL is executed per-node (never ON CLUSTER — docs/concept.md:20 says the opposite), and MATERIALIZE INDEX is intentionally operator-run, never emitted automatically. Both surfaced as misunderstandings in sqlgen: ALTER TABLE never emits ON CLUSTER — cluster-wide ALTERs apply to one node only #81 / sqlgen: ADD INDEX without MATERIALIZE INDEX — new index skips existing parts #84.

Fix direction

Add a README section per subcommand (a paragraph + one example each), link examples/manifest/, extend FAQ with introspect/dump-sql/sql2hcl recipes, fix the two stale CLAUDE.md lines, and add an "execution model & operational policies" section (per-node execution, MATERIALIZE INDEX policy). concept.md rewrite is tracked separately.

Found in the 2026-07-02 deep-dive audit (docs/plans/2026-07-02-deep-dive-improvement-areas.md, D1).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions