chore: sweep shipped strings and docs for issue/PR references that don't resolve on this tracker #39

New issue

Closed

opened 2026-07-13 18:35:55 +00:00 by hexajon · 0 comments

hexajon commented

2026-07-13 18:35:55 +00:00

(Migrated from codeberg.org)

Tool descriptions, help topics, steering/refusal texts, script comments (e.g. scripts/release.sh), and some docs carry issue/PR number citations that don't resolve on this tracker (it currently reaches ~#38) — they read as dangling references to any user or contributor.

#15's design rule 5 already covers the steering/refusal string class ("shipped strings carry the rule, not the reference") and proposes a lint over hook scripts and steer/refusal constants. This issue is the complementary sweep for everything else that ships:

MCP tool descriptions and action docs (the largest carrier)
madt_help topics and CLI help text
script headers/comments under scripts/
docs/ prose where a number is cited without context

Approach: extend (or reuse) the lint #15 proposes — reject #\d{3,}/issue \d{3,}/PR \d{3,} literals in shipped-string constants and doc sources unless the number resolves on this tracker; sweep existing violations in the same change (neutralize to "an earlier issue/PR" or drop, preserving the sentence's technical meaning). Dynamic numbers interpolated at runtime are exempt.

Acceptance:

No hardcoded non-resolving issue/PR literals in shipped strings or generated reference docs; lint proves it and runs in the gate.
Sentences remain grammatical and technically intact after the sweep.
Coordinate with #15 so the two lints don't diverge (one shared rule if practical).

Tool descriptions, help topics, steering/refusal texts, script comments (e.g. `scripts/release.sh`), and some docs carry issue/PR number citations that don't resolve on this tracker (it currently reaches ~#38) — they read as dangling references to any user or contributor. #15's design rule 5 already covers the *steering/refusal* string class ("shipped strings carry the rule, not the reference") and proposes a lint over hook scripts and steer/refusal constants. This issue is the complementary sweep for everything else that ships: - MCP tool descriptions and action docs (the largest carrier) - `madt_help` topics and CLI help text - script headers/comments under `scripts/` - `docs/` prose where a number is cited without context Approach: extend (or reuse) the lint #15 proposes — reject `#\d{3,}`/`issue \d{3,}`/`PR \d{3,}` literals in shipped-string constants and doc sources unless the number resolves on this tracker; sweep existing violations in the same change (neutralize to "an earlier issue/PR" or drop, preserving the sentence's technical meaning). Dynamic numbers interpolated at runtime are exempt. Acceptance: - No hardcoded non-resolving issue/PR literals in shipped strings or generated reference docs; lint proves it and runs in the gate. - Sentences remain grammatical and technically intact after the sweep. - Coordinate with #15 so the two lints don't diverge (one shared rule if practical).

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

sixfold-space/madtea#39

No description provided.

Rows
Columns