Skip to content

docs: scrub internal planning vocabulary from user-facing surfaces#50

Merged
gandarfh merged 2 commits into
mainfrom
chore/scrub-internal-planning-refs
May 18, 2026
Merged

docs: scrub internal planning vocabulary from user-facing surfaces#50
gandarfh merged 2 commits into
mainfrom
chore/scrub-internal-planning-refs

Conversation

@gandarfh
Copy link
Copy Markdown
Member

Summary

Removes personal/internal planning artifacts (Epic NN, Story NN, "V cenário", "vertical pass", docs-llm/jaum-audit/backlog, /auto-start) from the documentation a repo visitor actually reads.

  • CHANGELOG.md — ~95 provenance tags stripped; real refs kept as (see ADR 0004) / (see docs/MIGRATION.md); "v1 foundation / v2 vertical pass" summary reworded.
  • CLAUDE.md — inline planning tags removed; "Compact Instructions" rewritten as generic guidance (no docs-llm/jaum/epic/auto-start), still functional.
  • release.yml — "V12 cenário N" comment tags dropped (explanations kept; zero behaviour change).
  • docs/RELEASE.md, CONTRIBUTING.md — residual cenário/docs-llm/sweep-epic refs neutralized.
  • httui-web/CONTENT.md, SECTIONS.md — removed (internal landing drafts; landing is implemented).

Scope / not in this PR

~920 further references live in source-code comments (.ts/.tsx/.rs, 339 files). Intentionally excluded — that is a separate, larger, riskier sweep pending a scope decision. The .gitignore docs-llm/ rule is kept (it is what keeps the planning private).

Test plan

  • CI green (Rust Linux, Rust macOS smoke, Frontend) — changes are docs + comment-only YAML + 2 unimported .md deletions, so no code path affected
  • Spot-check CHANGELOG renders cleanly (no orphan parens, ADR/MIGRATION links intact)

gandarfh added 2 commits May 18, 2026 18:36
Strip personal/internal planning artifacts (Epic NN, Story NN,
"V<n> cenário", "vertical pass", docs-llm/jaum-audit/backlog,
/auto-start) from the documentation a repo visitor actually reads:

- CHANGELOG.md: all ~95 (Epic/V<n>/cenário/vertical) provenance tags
  stripped; real refs preserved as (see ADR 0004) / (see docs/
  MIGRATION.md); the "v1 foundation (epics 00–37) / v2 vertical pass
  (V1–V12)" summary reworded to neutral language.
- CLAUDE.md: inline planning tags removed from architecture headings;
  the "Compact Instructions" section rewritten as generic compaction
  guidance with no docs-llm/jaum/epic/auto-start references (still
  functional as a project doc).
- release.yml: "V12 cenário N" comment tags dropped (explanations
  kept; zero behaviour change).
- docs/RELEASE.md, CONTRIBUTING.md: residual cenário/docs-llm/sweep-
  epic references neutralized.
- httui-web/CONTENT.md, httui-web/SECTIONS.md: removed (internal
  landing-content drafts; the landing is implemented).

Scope note: ~920 further references live in source-code comments
(.ts/.tsx/.rs) across 339 files — intentionally NOT in this PR; that
is a separate, larger, riskier sweep pending a scope decision. The
`.gitignore` `docs-llm/` rule is kept (it is what keeps the planning
private).
- Source sweep: removed Epic/Story/cenário/docs-llm/jaum-audit/
  /auto-start tags from ~678 comment + test-description occurrences
  across 336 .ts/.tsx/.rs/.sql/Makefile/.sh/.plist/.js/.css files.
  Comment/test-name text only — zero executable code changed
  (cargo build + 3129 unit tests verified green). The 2 non-comment
  cases (a JSX placeholder, a size-check heredoc) reworded too.
- Fix CI red on main (was blocking every PR via the new ruleset):
  - EnvMenu de-flake used `user.click(el, {pointerEventsCheck:0})`
    — invalid 2nd arg (tsc TS2554). Moved to the correct
    `userEvent.setup({ pointerEventsCheck: 0 })`; still de-flaked
    (verified 3×), now type-clean.
  - prettier --check failed on the landing files edited earlier
    (App/Hero/InstallSection) — ran prettier --write.
- Verified locally: prettier --check clean, tsc --noEmit clean,
  zero remaining markers.
@gandarfh gandarfh merged commit 3a8ab51 into main May 18, 2026
4 of 5 checks passed
@gandarfh gandarfh deleted the chore/scrub-internal-planning-refs branch May 18, 2026 22:59
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