docs: condense AI instruction files#3571
Merged
PierreBrisorgueil merged 2 commits intomasterfrom Feb 24, 2026
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughRemoved example and editorial sections and consolidated command references across docs: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3571 +/- ##
=======================================
Coverage 95.93% 95.93%
=======================================
Files 20 20
Lines 516 516
Branches 140 140
=======================================
Hits 495 495
Misses 21 21 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
CLAUDE.md (2)
59-59: Make the stack-merge pointer more precise.“Stack merge workflow section” is a bit vague; consider naming the exact heading so readers can find it quickly and keep it merge-friendly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` at line 59, Change the vague phrase "stack merge workflow section" to a precise heading reference in the sentence — replace it with the exact README heading name (e.g., "Stack merge workflow") or include the full heading text in quotes so readers can jump directly to that section; update the line to read something like "Stack merge: see README — 'Stack merge workflow' section."
15-15: Add a stable anchor to the scripts reference.The one-liner is fine, but consider adding the exact README/package.json section name (or a heading anchor) to reduce ambiguity if scripts or docs grow.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` at line 15, The one-line reference "Scripts: see `package.json` → `scripts` section." is ambiguous; update the CLAUDE.md line to point to a stable anchor by referencing the exact heading or key path (e.g., the README heading "Scripts" or the explicit `package.json` key "scripts") so readers can jump directly to the section—replace the sentence with a precise anchor-style reference such as "Scripts: see README 'Scripts' section (or package.json `scripts` key)" or add the README/package.json heading anchor you use to make the link stable.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CLAUDE.md`:
- Line 59: Change the vague phrase "stack merge workflow section" to a precise
heading reference in the sentence — replace it with the exact README heading
name (e.g., "Stack merge workflow") or include the full heading text in quotes
so readers can jump directly to that section; update the line to read something
like "Stack merge: see README — 'Stack merge workflow' section."
- Line 15: The one-line reference "Scripts: see `package.json` → `scripts`
section." is ambiguous; update the CLAUDE.md line to point to a stable anchor by
referencing the exact heading or key path (e.g., the README heading "Scripts" or
the explicit `package.json` key "scripts") so readers can jump directly to the
section—replace the sentence with a precise anchor-style reference such as
"Scripts: see README 'Scripts' section (or package.json `scripts` key)" or add
the README/package.json heading anchor you use to make the link stable.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.claude/agents/stack-maintainer.md.github/copilot-instructions.mdAGENTS.mdCLAUDE.mdREADME.md
💤 Files with no reviewable changes (2)
- .claude/agents/stack-maintainer.md
- AGENTS.md
There was a problem hiding this comment.
Pull request overview
This PR reduces duplication across the repository’s AI/instruction documentation by replacing repeated command/workflow blocks with references to the canonical sources (package.json scripts, README sections, and .claude/skills/).
Changes:
- Condensed canonical command listings to a single reference to
package.jsonscripts. - Replaced detailed skill/modularity sections with brief pointers to the authoritative locations.
- Removed example/redundant sections from agent/instruction documents to keep guidance DRY.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Condenses Claude skills/modularity guidance into a one-line pointer to .claude/skills/. |
| CLAUDE.md | Replaces command table with a package.json reference; replaces stack merge commands with a pointer to README. |
| AGENTS.md | Removes duplicated preflight/review-format guidance, deferring to CLAUDE.md. |
| .github/copilot-instructions.md | Replaces canonical command list with a package.json reference; keeps prompts table. |
| .claude/agents/stack-maintainer.md | Removes the example review block to reduce duplication. |
Caution was lost when CLAUDE.md stack merge workflow was replaced by a pointer to README. Adding it back directly in README as the source of truth. Closes review feedback on #3571
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
package.jsonscripts; replaced stack merge workflow block with one-liner reference to README..github/copilot-instructions.md: replaced canonical commands list (~11 lines) with one-liner reference topackage.jsonscripts..claude/agents/stack-maintainer.md: removed Example review section at the bottom.Total: 5 files changed, ~65 lines removed, duplication eliminated.
Test plan
Summary by CodeRabbit