Agent eng docs improvement#2097
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
PR Review Summary
(3) Total Issues | Risk: Medium
🟠⚠️ Major (2) 🟠⚠️
🟠 1) redirects.json:207-210 Missing redirects for 6 of 7 deleted pages
Issue: The PR deletes 7 documentation pages but only adds a redirect for one of them (failure-modes → prompt-troubleshooting). The other 6 deleted pages have no redirects configured.
Why: Users who bookmarked or linked to these URLs will receive 404 errors. Search engine results for these pages will lead to broken links. This breaks the "no dead ends" principle for documentation sites. The missing pages are:
/guides/agent-engineering/choosing-patterns/guides/agent-engineering/handoff-protocol/guides/agent-engineering/operating-principles/guides/agent-engineering/personality-and-identity/guides/agent-engineering/testing-and-iteration/guides/agent-engineering/workflow-orchestrators
Fix: Add permanent redirects for each deleted page to the most appropriate destination:
{
"source": "/guides/agent-engineering/choosing-patterns",
"destination": "/guides/agent-engineering/multiagent-workflows",
"permanent": true
},
{
"source": "/guides/agent-engineering/handoff-protocol",
"destination": "/guides/agent-engineering/multiagent-workflows",
"permanent": true
},
{
"source": "/guides/agent-engineering/operating-principles",
"destination": "/guides/agent-engineering/prompt-structure",
"permanent": true
},
{
"source": "/guides/agent-engineering/personality-and-identity",
"destination": "/guides/agent-engineering/prompt-structure",
"permanent": true
},
{
"source": "/guides/agent-engineering/testing-and-iteration",
"destination": "/guides/agent-engineering/prompt-troubleshooting",
"permanent": true
},
{
"source": "/guides/agent-engineering/workflow-orchestrators",
"destination": "/guides/agent-engineering/multiagent-workflows",
"permanent": true
}Refs:
🟠 2) multiagent-workflows.mdx Content significantly thinner than deleted sources
Issue: The new multiagent-workflows.mdx page (54 lines) replaces content from workflow-orchestrators.mdx (232 lines), handoff-protocol.mdx (253 lines), and choosing-patterns.mdx (118 lines). Critical actionable guidance is lost, including:
- Handoff packet templates (structured context passing between agents)
- Return packet format (how subagents report back)
- Aggregation rules (dedup strategy, sort strategy, severity counts)
- Validation loops with bounded iterations
- Iteration policies with termination conditions
- Phase sequencing tables (purpose, inputs, outputs, quality gates)
- Artifact passing strategies
Why: Users designing multi-agent systems will lack essential guidance on structuring context handoffs, defining iteration limits, aggregating results from parallel subagents, and implementing quality gates. These patterns are foundational for reliable multi-agent systems.
Fix: Consider one of these approaches:
- Expand the page — Add back the handoff packet template and return packet format as core content, and iteration policies as a subsection
- Create a supplementary page — Keep
multiagent-workflows.mdxas a high-level overview and create an "Advanced Multi-agent Patterns" page with the detailed templates - Link to external references — If this content exists elsewhere (e.g., in the SDK docs or examples), add explicit cross-references
Refs:
- Deleted handoff-protocol.mdx — contained handoff/return packet templates
- Deleted workflow-orchestrators.mdx — contained phase sequencing and quality gates
🟡 Minor (1) 🟡
Inline Comments:
- 🟡 Minor:
multiagent-workflows.mdx:26Inconsistent hyphenation of "sub-agent"
💭 Consider (4) 💭
💭 1) multiagent-workflows.mdx:54 Anchor link may not resolve correctly
Issue: The link #4-workflow-checklist assumes a specific anchor slug for the heading "## 4. Workflow checklist" — MDX/Fumadocs slugification rules may generate a different anchor.
Fix: Verify the link works in the built docs, or use an explicit anchor: ## 4. Workflow checklist {#workflow-checklist}
💭 2) index.mdx:26, multiagent-workflows.mdx:54, prompt-structure.mdx:171 Missing trailing newlines
Issue: Three MDX files do not end with a trailing newline, inconsistent with peer documentation files.
Fix: Add a newline at the end of each file.
💭 3) prompt-troubleshooting.mdx Missing delegation tuning guidance
Issue: The deleted testing-and-iteration.mdx contained delegation tuning guidance ("If delegation is too frequent", "If delegation never happens") that is not present in the new troubleshooting page.
Fix: Consider adding an accordion section for "Delegation behavior" under Common issues and fixes.
💭 4) prompt-troubleshooting.mdx:4 Description could be more descriptive
Issue: The description "Fix common sub agent prompt issues." is notably shorter than peer files.
Fix: Consider expanding to match sibling files, e.g., "Diagnose common sub agent prompt issues and apply targeted fixes to improve agent reliability."
🚫 REQUEST CHANGES
Summary: The documentation consolidation is a reasonable restructuring, but the PR is missing redirects for 6 of 7 deleted pages — this will cause 404 errors for bookmarked/linked URLs and should be addressed before merging. The content reduction in multiagent-workflows.mdx also warrants discussion on whether key templates should be preserved.
Discarded (4)
| Location | Issue | Reason Discarded |
|---|---|---|
index.mdx |
Removed conceptual framing (agents vs skills vs rules) | May be intentional design choice; LOW confidence this is an oversight |
prompt-troubleshooting.mdx:4 |
Short description | Nitpick; INFO severity |
prompt-structure.mdx:167-171 |
Sparse few-shot section | Design choice; original content may have been over-detailed |
multiagent-workflows.mdx |
Duplicate finding about missing content | Merged with Main finding #2 |
Reviewers (3)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
pr-review-docs |
7 | 2 | 2 | 0 | 0 | 0 | 3 |
pr-review-product |
4 | 0 | 1 | 0 | 0 | 0 | 3 |
pr-review-consistency |
4 | 0 | 1 | 0 | 1 | 0 | 2 |
| Total | 15 | 2 | 4 | 0 | 1 | 0 | 8 |
Note: High overlap between reviewers on the missing redirects issue (all 3 flagged it); merged to single Main finding.
| - A coordinator must combine outputs from several specialists | ||
| - You need parallel specialist work and explicit quality gates | ||
|
|
||
| <Tip>If a sub-agent needs more than five tools, split it into smaller, specialized sub-agents to avoid context overload.</Tip> |
There was a problem hiding this comment.
🟡 Minor: Inconsistent hyphenation of "sub-agent"
Issue: This line uses "sub-agent" (hyphenated), but the rest of the file uses "sub agent" (unhyphenated) — see lines 8, 14, 50, 51, 54.
Why: Inconsistent terminology within the same document can confuse readers and appears unpolished.
Fix: (1-click apply)
| <Tip>If a sub-agent needs more than five tools, split it into smaller, specialized sub-agents to avoid context overload.</Tip> | |
| <Tip>If a sub agent needs more than five tools, split it into smaller, specialized sub agents to avoid context overload.</Tip> |
Refs:
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Inkeep Agent Framework Docs' |
There was a problem hiding this comment.
PR Review Summary
(0) Total Issues | Risk: Low
This is a delta re-review scoped to changes since the prior automated review. The delta consists of a single commit adding a helpful <Callout> tip to prompt-structure.mdx.
Delta Analysis
Change: Added a tip explaining that the "Agent Prompt" is inherited by all sub-agents and should be used for shared instructions (MCP tool guidelines, global constraints, output conventions).
Assessment:
- ✅ The tip is clear, actionable, and provides concrete examples
- ✅ It fills a documentation gap by explaining the Agent Prompt vs sub-agent prompt distinction
- ✅ No new issues introduced in this delta
🕐 Pending Recommendations (2)
The following issues from the prior review remain applicable to the full PR:
- 🟠
redirects.json:207-210Missing redirects for 6 of 7 deleted pages - 🟡
multiagent-workflows.mdx:26Inconsistent hyphenation of "sub-agent"
✅ APPROVE
Summary: The delta change is a valuable documentation improvement with no issues. The PR is already merged. Prior review feedback about missing redirects and content reduction remains relevant for follow-up consideration.
Reviewers (0)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
| Direct assessment | 1 | 0 | 0 | 0 | 0 | 2 | 0 |
| Total | 1 | 0 | 0 | 0 | 0 | 2 | 0 |
Note: Delta was too small to warrant subagent dispatch. Direct orchestrator assessment performed.
* first pass * moved key concepts * consolidated agent eng sections * renamed * more user friendly * streamlined * polish prompt troubleshooting * renaming and reordering * done * added agent prompt guidance
No description provided.