docs: untrack internal design notes - #19
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 x402plan specified an
X402_TESTNET_API_URLconstant and a hardcoded testnet URL that weredeliberately 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 underdocs/, so the folder is now gone..gitignore: ignore/docsso it cannot be silently re-tracked. Optional and trivial todrop if you'd rather keep the ability to version docs later.
What is preserved
.claude/docs/superpowers/specs/2026-09-21-esm-entry-rework-design.md(.claudeis gitignored).CHANGELOG.md(0.10.0) andCLAUDE.md→ Build Targets.Review notes
This deviates from the "bump version before every commit" rule in
CLAUDE.md; flagging it sothe omission is an explicit choice rather than an oversight.
main, so merging will cut one regardless.pnpm test(53 passing) andpnpm run buildran via the pre-commit hook.