Skip to content

docs(research): streamline research guidance - #653

Merged
baleen37 merged 1 commit into
mainfrom
feat/improve-research
May 13, 2026
Merged

docs(research): streamline research guidance#653
baleen37 merged 1 commit into
mainfrom
feat/improve-research

Conversation

@baleen37

@baleen37 baleen37 commented May 13, 2026

Copy link
Copy Markdown
Owner

Summary

  • Balance the research skill between quick lookup and deeper evidence-based investigation.
  • Update the web-researcher agent to remove obsolete mgrep guidance and prefer Context7/WebSearch/WebFetch.

Changes

  • Add depth selection guidance for quick lookup, codebase mapping, behavior research, web docs, and hybrid research.
  • Relax fixed 3-source guidance so evidence depth matches risk.
  • Shorten web-researcher output expectations and clarify when multiple sources are needed.

Tests

  • pre-commit run --files plugins/me/skills/research/SKILL.md plugins/me/agents/web-researcher.md

Summary by CodeRabbit

  • Documentation
    • Restructured web researcher agent with clearer guidance on tool selection for different research types
    • Updated research skill documentation with improved depth-selection criteria and risk-based evidence evaluation standards
    • Enhanced guidance on investigation stopping points and evidence validation practices

Review Change Stack

@baleen37
baleen37 enabled auto-merge (squash) May 13, 2026 03:46
@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a6fafe44-805b-411f-bdc4-b0bde913045c

📥 Commits

Reviewing files that changed from the base of the PR and between d5f3e62 and c5043de.

📒 Files selected for processing (2)
  • plugins/me/agents/web-researcher.md
  • plugins/me/skills/research/SKILL.md

📝 Walkthrough

Walkthrough

This PR refactors research guidance across two documentation artifacts. The web-researcher agent is condensed into a structured playbook with modernized tool workflows and output templates. The research skill is revised to shift from prescriptive source-count rules toward risk-based evidence depth and practical verification-first methodology.

Changes

Research guidance modernization

Layer / File(s) Summary
Web-researcher agent modernization
plugins/me/agents/web-researcher.md
Frontmatter is tightened to describe use-case; tool selection (Context7, WebSearch, WebFetch, gh) replaces mgrep-based guidance; evidence depth is formalized with source-quality preferences and version/date handling; output format is standardized to Answer/Evidence/Confidence-Gaps template with simplified common-mistakes list.
Research skill methodology overhaul
plugins/me/skills/research/SKILL.md
Frontmatter description is updated; new "Depth Selection" section maps research needs to investigation approach and stopping criteria (quick lookup, codebase map, repro, web/current docs, hybrid); evidence standards shift from fixed source counts to risk-matched depth with explicit rules for observed output claims and negative evidence documentation; red flags are condensed to discourage over-research, broad manual search, code-only claims, and unsourced web content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A researcher's guide made trim and neat,
From mgrep to tools more complete!
Web-Fetch and Search in harmony blend,
Evidence depth—on risk to depend.
No endless sources, just safe and sound,
Better guidance found! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(research): streamline research guidance' clearly and concisely summarizes the main change—refactoring research documentation to make it more streamlined and clearer. It accurately reflects the primary objective of rebalancing and simplifying both the research skill and web-researcher agent.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/improve-research

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

auto-merge was automatically disabled May 13, 2026 03:47

Repository rule violations found

@baleen37
baleen37 merged commit 94651ae into main May 13, 2026
5 checks passed
@baleen37
baleen37 deleted the feat/improve-research branch May 13, 2026 03:48
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