Skip to content

docs(cookbook): revamp debug-traces-from-ide against playbook#662

Open
SuhaniNagpal7 wants to merge 1 commit into
devfrom
docs/mcp-debug-traces-revamp
Open

docs(cookbook): revamp debug-traces-from-ide against playbook#662
SuhaniNagpal7 wants to merge 1 commit into
devfrom
docs/mcp-debug-traces-revamp

Conversation

@SuhaniNagpal7
Copy link
Copy Markdown
Contributor

Summary

Brings cookbook/mcp/debug-traces-from-ide to the playbook bar:

  • Frontmatter rewritten to the kebab-case schema (slug, author, products, frameworks, difficulty, tags, og-image, canonical, last-tested-date, structured last-tested-with, code-repo-url, page-type).
  • New "What you'll build" section with 5 concrete artifact bullets.
  • "Why this matters" anchored in the tab-switching incident (5 context switches per fix attempt) with all four playbook elements.
  • Mermaid loop diagram of the diagnose-fix-verify cycle (uses <Mermaid> from docs(cookbook): revamp eval-correction-loop + add Mermaid component #660).
  • Troubleshooting table gained a Verify column.
  • Next steps rewritten as a 4-item technical ladder + 1 reference link.
  • 5 real terminal screenshots added after each Step 3 example, each with descriptive alt text covering the IDE, the tool call, project/trace IDs, and the assistant's follow-up.

Em dashes purged across the file.

Depends on

  • #660 — adds the <Mermaid> component that this page now uses. Merge that first.

Test plan

  • pnpm dev and visit /docs/cookbook/mcp/debug-traces-from-ide — confirm the Mermaid flowchart renders as a 4-node loop (not raw code).
  • All 5 Step 3 screenshots load from fi-cookbook-assets.s3.ap-south-1.amazonaws.com/mcp/debug-traces-from-ide/.
  • Confirm pnpm astro build passes.

Scope

  • Only cookbook/mcp/debug-traces-from-ide.mdx. Other locally modified files (semantic-caching.mdx, docker-compose-quickstart.mdx, async-batch-eval.mdx) are intentionally not in this PR.

- Frontmatter expanded to kebab-case schema (slug, author, products,
  frameworks, difficulty, tags, og-image, canonical, last-tested-date,
  structured last-tested-with, code-repo-url, page-type).
- Added "What you'll build" section with 5 concrete artifact bullets.
- Rewrote "Why this matters" with the tab-switching incident lead
  (5 context switches per fix attempt) and the four playbook elements:
  bad outcome, why standard tooling misses it, which FAGI capability
  helps, metric that proves the fix.
- Added Mermaid loop diagram of the diagnose-fix-verify cycle
  (ask -> MCP fetches -> IDE patches -> re-ask -> done/loop).
- Em dashes purged across body and inline tips.
- Troubleshooting table gained "Verify" column.
- Replaced "Explore further" reference cards with a 4-item technical
  next-steps ladder (IDE snippets, triaged-by-mcp label, quarterly
  OAuth review, Falcon AI fallback).
- Added 5 real terminal screenshots after each Step 3 example
  (find-failing-traces, inspect-span-tree, run-error-analysis,
  analyze-project-traces, tag-and-annotate) with descriptive alt
  text covering tool calls, project/trace IDs, and assistant follow-ups.
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