[WIP] Markdown for Agents documentation#28110
Conversation
threepointone
left a comment
There was a problem hiding this comment.
blocking while we discuss
|
/bonk review this PR and resolve merge conflicts |
Resolved conflicts in sidebar ordering for model-context-protocol/index.mdx, mcp-agent-api.mdx, and x402.mdx. Kept PR's sidebar reordering (to accommodate new Markdown for Agents page at order 4) while preserving production's richer content additions (elicitation, serve(), data jurisdiction sections).
There was a problem hiding this comment.
PR Review: Markdown for Agents documentation
Merge Conflicts
Resolved 3 merge conflicts:
model-context-protocol/index.mdx: Kept PR's sidebar reordering (order: 5+group.hideIndex) to accommodate the new page at order 4.model-context-protocol/mcp-agent-api.mdx: Applied PR'sorder: 7sidebar change while preserving production's richer content (elicitation,serve(), data jurisdiction, etc. that were added since this branch diverged).x402.mdx: Kept PR's sidebar reordering (order: 6+group.hideIndex).
Issues Found
Important (should fix before merge)
-
Unused imports (
markdown-for-agents.mdx:12-18):MetaInfo,Type, andWranglerConfigare imported but never used. OnlyRenderandTypeScriptExampleare actually used. -
List numbering error (
partials/agents/markdown-for-agents.mdx:13): Steps 2 and 3 are both numbered2.:2. Select the zone you want to configure. 2. Look for **Quick Actions**. ← should be 3. -
API path mismatch (
partials/agents/markdown-for-agents.mdx:18): The prose says/api/v4/zones/{zone_tag}/settings/content_converterbut the curl example correctly useshttps://api.cloudflare.com/client/v4/.... The correct base path is/client/v4/, not/api/v4/.
Minor nits
-
Availability sentence (
markdown-for-agents.mdx:81): "available to Pro and Business plans and SSL for SaaS customers" reads ambiguously. Consider: "available at no cost to Pro plans, Business plans, and SSL for SaaS customers." -
Absolute vs relative links (
markdown-for-agents.mdx:87-88): Links to Workers AI and Browser Rendering use absolute URLs (https://developers.cloudflare.com/...) — relative paths (/workers-ai/...) are preferred for internal links. -
Hyphenation (
markdown-for-agents.mdx:94): "zone level setting" → "zone-level setting" (compound adjective). -
Parenthetical punctuation (
partials/agents/markdown-for-agents.mdx:11): Period should be outside the parenthesis: "(you need a Pro or Business plan)." not "(you need a Pro or Business plan.)" -
Vague dashboard instructions (
partials/agents/markdown-for-agents.mdx:13-14): "Look for Quick Actions" doesn't specify where in the dashboard. Other Cloudflare docs typically specify the navigation path.
Note
This PR has a blocking review from @threepointone. The merge conflict resolution and any fixes should be staged, but the PR should not merge until that discussion is resolved.
|
Here's a summary of what I did: Merge Conflicts Resolved3 real conflicts found and resolved (all in sidebar ordering due to the new "Markdown for Agents" page insertion at order 4):
PR Review SummaryFound 3 important issues and 5 minor nits: Important:
Note: The PR has a blocking review from @threepointone ("blocking while we discuss"), so it shouldn't merge until that's resolved regardless. |
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
/bonk address the review issues for Celso and thank him in Portuguese |
Co-authored-by: elithrar <elithrar@users.noreply.github.com>
src/content/changelog/fundamentals/2026-02-12-markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
src/content/changelog/fundamentals/2026-02-12-markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
src/content/changelog/fundamentals/2026-02-12-markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
src/content/changelog/fundamentals/2026-02-12-markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/fundamentals/reference/markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/fundamentals/reference/markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/fundamentals/reference/markdown-for-agents.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Matt Kane <mkane@cloudflare.com>
Co-authored-by: Matt Kane <mkane@cloudflare.com>
…udflare-docs into celso/markdown-for-agents
Co-authored-by: Matt Kane <mkane@cloudflare.com>
87fb0c2 to
693f37c
Compare
Summary
Adds Markdown for Agents documentation
Documentation checklist