Skip to content

[WIP] Markdown for Agents documentation#28110

Merged
celso merged 19 commits intoproductionfrom
celso/markdown-for-agents
Feb 12, 2026
Merged

[WIP] Markdown for Agents documentation#28110
celso merged 19 commits intoproductionfrom
celso/markdown-for-agents

Conversation

@celso
Copy link
Collaborator

@celso celso commented Feb 5, 2026

Summary

Adds Markdown for Agents documentation

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/m labels Feb 5, 2026
Copy link
Contributor

@threepointone threepointone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blocking while we discuss

@elithrar
Copy link
Collaborator

elithrar commented Feb 6, 2026

/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).
Copy link
Contributor

@ask-bonk ask-bonk bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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's order: 7 sidebar 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)

  1. Unused imports (markdown-for-agents.mdx:12-18): MetaInfo, Type, and WranglerConfig are imported but never used. Only Render and TypeScriptExample are actually used.

  2. List numbering error (partials/agents/markdown-for-agents.mdx:13): Steps 2 and 3 are both numbered 2.:

    2. Select the zone you want to configure.
    2. Look for **Quick Actions**.  ← should be 3.
    
  3. API path mismatch (partials/agents/markdown-for-agents.mdx:18): The prose says /api/v4/zones/{zone_tag}/settings/content_converter but the curl example correctly uses https://api.cloudflare.com/client/v4/.... The correct base path is /client/v4/, not /api/v4/.

Minor nits

  1. 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."

  2. 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.

  3. Hyphenation (markdown-for-agents.mdx:94): "zone level setting" → "zone-level setting" (compound adjective).

  4. 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.)"

  5. 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.

@ask-bonk
Copy link
Contributor

ask-bonk bot commented Feb 6, 2026

Here's a summary of what I did:

Merge Conflicts Resolved

3 real conflicts found and resolved (all in sidebar ordering due to the new "Markdown for Agents" page insertion at order 4):

File Resolution
model-context-protocol/index.mdx Kept PR's order: 5 + group.hideIndex: false
model-context-protocol/mcp-agent-api.mdx Applied PR's order: 7 but kept production's richer content (elicitation, serve(), data jurisdiction sections)
x402.mdx Kept PR's order: 6 + group.hideIndex: false

PR Review Summary

Found 3 important issues and 5 minor nits:

Important:

  1. Unused imports (MetaInfo, Type, WranglerConfig) in the main page
  2. Duplicate list numbering (two step 2.s) in the partial
  3. API path mismatch: prose says /api/v4/ but should be /client/v4/

Note: The PR has a blocking review from @threepointone ("blocking while we discuss"), so it shouldn't merge until that's resolved regardless.

github run

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/pcx-technical-writing
/src/content/docs/browser-rendering/ @mchenco, @cloudflare/pcx-technical-writing, @celso, @kathayl, @ToriLindsay
/src/content/docs/fundamentals/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/workers-ai/ @rita3ko, @craigsdennis, @mchenco, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

@elithrar
Copy link
Collaborator

elithrar commented Feb 7, 2026

/bonk address the review issues for Celso and thank him in Portuguese

Co-authored-by: elithrar <elithrar@users.noreply.github.com>
@celso celso requested a review from a team as a code owner February 11, 2026 16:34
@dinasaur404 dinasaur404 force-pushed the celso/markdown-for-agents branch from 87fb0c2 to 693f37c Compare February 11, 2026 22:29
@celso celso merged commit 71010b8 into production Feb 12, 2026
9 checks passed
@celso celso deleted the celso/markdown-for-agents branch February 12, 2026 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.