docs: remove dead internal-tooling references#1
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Removes internal-only “BMAD” workflow references from contributor-facing documentation to make the repository clearer for public/open-source audiences.
Changes:
CONTRIBUTING.md: Removed a dead internal link and story reference while keeping the “no source-grep tests” rule.CODE_REVIEW.md: Removed an internal-only note about_bmad/_bmad-outputsymlinks into a sibling repo.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CONTRIBUTING.md | Removes internal link/story reference while preserving the testing guidance. |
| CODE_REVIEW.md | Deletes internal repo-layout/symlink guidance that won’t apply to public contributors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
gunnsth
changed the title
unidoc-anom
approved these changes
Jul 14, 2026
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.
Description and links
Cleaning up docs before this repo goes public. Two reader-facing docs referenced internal, non-existent-to-outsiders paths — dead links and internal process detail that don't mean anything (and look broken) to outside contributors.
Technical changes
CONTRIBUTING.md: removed a dead link to a gitignored internal path and an internal story-number reference, kept the substance of the rule (grandfathered greps pending bulk-removal follow-up).CODE_REVIEW.md: removed a bullet describing symlinks into a sibling internal repo — internal-only detail, doesn't apply to how the public repo is laid out.Considerations
Scope is deliberately narrow: reader-facing docs only (CONTRIBUTING.md, CODE_REVIEW.md). There are other internal-story-provenance comments in a few test files (e.g.
tests/source-grep-guard,tests/10-4-pdfcpu-0-12-1-bump) that reference the same internal tooling by name in doc comments — those are left as-is since they're not reader-facing and carry no functional dependency on the path.tests/open-source-docs/docs_test.goalso has an active regression test guarding against exactly this kind of dead-link leak in README.md — kept, since it's doing its job.How was this tested?
Docs-only change, no code affected.
What could go wrong?
Low risk — text-only edits, no behavior change.
Checklist
devbranch, notmaster