Skip to content

docs: untrack internal design notes - #19

Merged
planadecu merged 1 commit into
mainfrom
chore/untrack-internal-docs
Sep 22, 2026
Merged

planadecu merged 1 commit into
mainfrom
chore/untrack-internal-docs

Conversation

@planadecu

Copy link
Copy Markdown
Owner

Internal design/planning notes are working documents for the agent tooling, not user-facing
documentation. This removes the last one from version control (it came back in when #18 merged)
and guards against it happening again.

Why

Versioned planning docs go stale and end up contradicting src/. Concretely, the retired x402
plan specified an X402_TESTNET_API_URL constant and a hardcoded testnet URL that were
deliberately removed from the implementation — see the comment in src/types/config.ts.
Nothing in the repo references docs/.

Change

  • git rm docs/superpowers/specs/2026-09-21-esm-entry-rework-design.md — the only file under
    docs/, so the folder is now gone.
  • .gitignore: ignore /docs so it cannot be silently re-tracked. Optional and trivial to
    drop
    if you'd rather keep the ability to version docs later.

What is preserved

  • The note itself, byte-identical, at
    .claude/docs/superpowers/specs/2026-09-21-esm-entry-rework-design.md (.claude is gitignored).
  • The durable rationale for the ESM rework is unaffected: CHANGELOG.md (0.10.0) and
    CLAUDE.md → Build Targets.

Review notes

  • No version bump or CHANGELOG entry, deliberately — docs-only, no API or runtime change.
    This deviates from the "bump version before every commit" rule in CLAUDE.md; flagging it so
    the omission is an explicit choice rather than an oversight.
  • Merging this does not need a publish, but the workflow publishes a patch on every push to
    main, so merging will cut one regardless.
  • pnpm test (53 passing) and pnpm run build ran via the pre-commit hook.

Internal design/planning notes are working documents for the agent
tooling, not user-facing documentation. Versioning them means they go
stale and end up contradicting src/ — the retired x402 plan specified an
X402_TESTNET_API_URL constant that was never shipped (see the comment in
src/types/config.ts).

The current note is preserved locally at
.claude/docs/superpowers/specs/2026-09-21-esm-entry-rework-design.md
(.claude is gitignored). The durable rationale for the ESM rework already
lives in CHANGELOG.md (0.10.0) and CLAUDE.md (Build Targets).

Also ignore /docs so the folder cannot be silently re-tracked.

Docs-only; no API or runtime change, so no version bump.
@planadecu
planadecu merged commit 8bd6c19 into main Sep 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant