Skip to content

Docs drift: CLAUDE.md inaccuracies, stale paths, 63 historical plan docs mixed into user docs, docs site never built in CI #519

Closed

Description

@antosubash

Tier 3: documentation

Inaccuracies found

Structural problems

  • Historical plans mixed into user docs. docs/superpowers/ holds 63 dated, agent-generated plans and specs, and docs/plans/ holds 10 more, alongside the user docs.
  • Docs site never built. docs/package.json (VitePress) isn't in the root workspaces, and no workflow builds or link-checks it, so dead links and stale paths pile up unnoticed.
  • CLAUDE.md is too dense. It runs to about 3,500 words, with single paragraphs over 300 words (hooks, middleware, database). Every invariant written only as prose is one that nothing enforces, and some of it is already wrong.

Fix

  1. Fix the inaccuracies above.
  2. Move docs/superpowers/ and the older docs/plans/ into docs/archive/, or delete them, and exclude them from the site.
  3. Add a CI job that builds the VitePress site and runs a link and path checker. A simple check: every backticked repo path in *.md must exist.
  4. Cut CLAUDE.md down to pointers into docs/framework/*, and turn the prose invariants into tests or boot-time assertions where possible.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions