docs: drop dead spec-section pointers from public files + code comments#24
Merged
Conversation
The design spec lives under .claude/docs/superpowers/specs/, which is gitignored. Citations like "see spec §5.5" or "(§6.3)" are dead pointers for anyone reading the codebase outside the original author's local workstation. Replaced each with the concrete concept the section described: - README.md:159 - "spec §5.5" -> "envelope (target, overview, findings, warnings)" - internal/output/json/json.go - "§5.5 schema" -> explicit field list - internal/cli/render.go - "§5.5 envelope" -> "Report envelope" - internal/findings/severity.go - "JSON schema in the spec (§5.5)" -> "lower-case string (critical|high|medium|low) for the public JSON wire form" - internal/analyzers/labelpattern/patterns.go - "spec (§6.3)" -> "high-cardinality label-name patterns the analyzer flags by default" No behavior change; comment-only.
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
1 participant
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.
Summary
The design spec lives under
.claude/docs/superpowers/specs/, which is gitignored. Citations likespec §5.5or(§6.3)are dead pointers for anyone reading the codebase outside the original author's local workstation. Replaced each with the concrete concept the section described.Touched
README.md:159-"spec §5.5"->"envelope (target, overview, findings, warnings)"internal/output/json/json.go-"§5.5 schema"-> explicit field listinternal/cli/render.go-"§5.5 envelope"->"Report envelope"internal/findings/severity.go-"JSON schema in the spec (§5.5)"->"lower-case string (critical|high|medium|low) for the public JSON wire form"internal/analyzers/labelpattern/patterns.go-"spec (§6.3)"->"high-cardinality label-name patterns the analyzer flags by default"No behavior change; comment-only.
Test plan
go test ./... -count=1(all pass)make fmt vet lint vuln(clean)grep -rn "spec\.md\|spec §\|§[0-9]" docs/ README.md mkdocs.yml internal/ cmd/returns zero matches