[docs] docs: unbloat ResearchPlanAssignOps pattern (21% reduction)#36503
Conversation
Remove redundant content from research-plan-assign-ops.md (230 → 182 lines, 21% reduction) while preserving all essential information: - Condense the End-to-End Example, which re-traced the four phases already described above it, into a 3-bullet timeline - Drop two "Workflow Configuration Patterns" research subsections that duplicated the Phase 1 example (cache-memory and create-discussion); the remaining Plan/Assign knobs (group, assignees) are kept - Convert the Customization 5-bullet list to prose and remove the planning-approach bullet that repeated the assignees:copilot guidance already covered in the Assign config and When-to-Use sections Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
automation
doc-unbloat
documentation
pelikhan
deleted the
docs/unbloat-research-plan-assign-ops-a057cf3d9cacae52
branch
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. No ADR enforcement needed: PR #36503 does not have the 'implementation' label and has 0 new lines of code in business logic directories (threshold is 100). The changed files are shell/python scripts under .github/skills and .github/workflows, none of which fall under the configured business-logic directories. |
|
✅ PR Code Quality Reviewer completed the code quality review. |
|
🧪 Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. The only change is to docs/src/content/docs/patterns/research-plan-assign-ops.md (a documentation file). Test Quality Sentinel skipped. |
There was a problem hiding this comment.
Pull request overview
This PR reduces redundancy in the ResearchPlanAssignOps pattern documentation by condensing repeated sections while keeping the key configuration guidance and phase narrative intact.
Changes:
- Replaced the long end-to-end trace with a short timeline summary.
- Removed duplicated research-configuration subsections in favor of referencing the Phase 1 example.
- Condensed the Customization list into a single prose paragraph.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/patterns/research-plan-assign-ops.md | Removes duplicated/redundant explanations and compresses examples while preserving core configuration details and links. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
| - **Monday afternoon** — A developer types `/plan` on the discussion. The planner opens a `[plan] cobra improvements` tracking issue with three sub-issues (context propagation, `PersistentPreRunE` refactor, cancellation tests), then assigns the first two to Copilot, which opens PRs within minutes. | ||
| - **Tuesday** — The developer reviews the PRs, requests one minor change, and merges both. The tracking issue closes automatically. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · sonnet46 898.4K
|
|
||
| `close-older-discussions: true` prevents discussion accumulation—only the latest finding stays open for the planner. | ||
| The Phase 1 example already shows the core research config (`create-discussion` with `close-older-discussions: true`, plus `cache-memory`). Two more safe-output knobs shape the later phases. | ||
|
|
There was a problem hiding this comment.
[/grill-with-docs] The transition sentence forward-references Phase 1, which may confuse readers who jump directly to this section from a search or link.
💡 Suggestion
Consider making the sentence self-contained, e.g.:
The research phase uses
create-discussionwithclose-older-discussions: trueand optionallycache-memory; the two subsections below cover the plan and assign phases.
This removes the assumption that the reader has just finished reading Phase 1.
There was a problem hiding this comment.
Documentation-only change. The condensed end-to-end example is cleaner and the removal of the duplicate research config blocks is justified by the Phase 1 section already showing both close-older-discussions: true and cache-memory.
Minor: Customization section readability
The original bulleted list (research focus, frequency, report format, assignment method) was easier to scan than the replacement dense paragraph. Consider restoring bullet points — no other concerns.
🔎 Code quality review by PR Code Quality Reviewer · sonnet46 112K
Summary
Reduces noise in the
ResearchPlanAssignOpspattern doc by condensing verbose prose and redundant multi-block code examples into tighter inline descriptions and bullet points — a net 38-line (21%) reduction with no content loss.Changes
docs/src/content/docs/patterns/research-plan-assign-ops.md(modified)Impact
Checklist