docs(ai): condense AI instruction files, remove duplication#3165
docs(ai): condense AI instruction files, remove duplication#3165PierreBrisorgueil merged 2 commits intomasterfrom
Conversation
- Replace commands tables with pointer to package.json - Replace stack merge workflow in CLAUDE.md with pointer to README - Remove preflight and review convention from AGENTS.md (delegated to CLAUDE.md) - Remove example review section from stack-maintainer.md - Replace Claude skills table in README with one-liner, remove duplicate architecture rules section Closes #3164
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughRemoved duplicated, example, and explicit command content across AI-instruction docs; replaced command lists with references to Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 #3165 +/- ##
=======================================
Coverage 89.86% 89.86%
=======================================
Files 52 52
Lines 1164 1164
Branches 234 234
=======================================
Hits 1046 1046
Misses 107 107
Partials 11 11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Reduces duplication across AI-related documentation by centralizing canonical commands in package.json and consolidating shared guidance, leaving each instruction file focused on tool-specific content.
Changes:
- Replace duplicated “canonical commands” sections with pointers to
package.jsonscripts. - Condense AI setup docs by removing repeated skills/architecture content and linking to the relevant source files.
- Trim agent-focused docs (AGENTS + stack-maintainer) to avoid repeating preflight/review conventions.
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 skill listing / removes duplicated architecture rules, points to .claude/skills/. |
| CLAUDE.md | Removes duplicated command table and merge workflow snippet; points to package.json and README. |
| AGENTS.md | Removes duplicated preflight + review convention; delegates shared rules to CLAUDE.md. |
| .github/copilot-instructions.md | Replaces canonical command list with a pointer to package.json scripts. |
| .claude/agents/stack-maintainer.md | Removes example review block to reduce duplication. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CLAUDE.md (1)
59-61: Consider using a relative Markdown link for the cross-reference.Plain prose works, but a relative link makes it clickable in rendered Markdown and more explicit for AI tools scanning the file.
🔗 Proposed improvement
-See README — stack merge workflow section. +See [README — Stack Merge Workflow section](README.md#stack-merge-workflow).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` around lines 59 - 61, Replace the plain cross-reference under the "## Stack merge workflow" heading with a relative Markdown link to the README section (e.g., change "See README — stack merge workflow section." to a clickable relative link like "See README — [stack merge workflow](README.md#stack-merge-workflow)"); update the link target to match the README section slug for "Stack merge workflow" so it becomes clickable and machine-friendly.
🤖 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`:
- Around line 59-61: Replace the plain cross-reference under the "## Stack merge
workflow" heading with a relative Markdown link to the README section (e.g.,
change "See README — stack merge workflow section." to a clickable relative link
like "See README — [stack merge workflow](README.md#stack-merge-workflow)");
update the link target to match the README section slug for "Stack merge
workflow" so it becomes clickable and machine-friendly.
ℹ️ 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
Align with Vue repo — caution was lost when CLAUDE.md stack merge block was replaced by a pointer to README.
Summary
Scope
nonelowValidation
npm run lintnpm testGuardrails check
.env*,secrets/**, keys, tokens)Optional: Infra/Stack alignment details
Before vs After (key changes only)
Notes for reviewers
Summary by CodeRabbit