Skip to content

CFSA-403 Introduce beta docs for cloudflare agent#28899

Open
kale-stew wants to merge 6 commits intocloudflare:productionfrom
kale-stew:kylie/cloudflare-agent-beta
Open

CFSA-403 Introduce beta docs for cloudflare agent#28899
kale-stew wants to merge 6 commits intocloudflare:productionfrom
kale-stew:kylie/cloudflare-agent-beta

Conversation

@kale-stew
Copy link
Contributor

Summary

We recently rolled out a new user-facing feature, Cloudflare Agent. Users were confused when they saw the auto-generated token and couldn't look it up in our documentation. This new file aims to address that and provide a general baseline for the product's capabilities, known limitations, and how it is being built.

Considerations

  • We do not support a free id in the Plan component. Is this intentional? Should I introduce one, or remove the use of Plan from this file entirely (as I have done)?
  • Are there conventions for pre-release docs like this one? We do not yet have a Changelog post mapping to this product's release, but could introduce one for initial beta if it makes the most sense for docs.

Documentation checklist

@kale-stew kale-stew requested a review from a team as a code owner March 10, 2026 18:35
Copy link
Contributor

@kristianfreeman kristianfreeman left a comment

Choose a reason for hiding this comment

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

This is great, +1

should we consider mentioning something about Lee in here? not a blocker to merge imo

@kale-stew
Copy link
Contributor Author

This is great, +1

should we consider mentioning something about Lee in here? not a blocker to merge imo

I both do and do not want to use the name that wasn't ever really meant to leak out into userland. It's helpful for anyone trying to search plaintext "Lee" investigating last week's random token, but the token is also now renamed to Cloudflare Agent for simplicity's sake. Open to whatever feels right here, but my personal preference is to not further bolster the codename in public. :)

@kodster28
Copy link
Collaborator

/bonk review and provide any relevant suggestions

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.

4 issues found — 1 medium, 3 low. Posted inline suggestions for each.

@ask-bonk
Copy link
Contributor

ask-bonk bot commented Mar 10, 2026

Review posted. Here's a summary of what I found:

MEDIUM (1)

  • src/content/directory/cloudflare-agent.yaml — Missing id field. Every other directory YAML file (162/162) has one. This is likely needed by the content collection loader.

LOW (3)

  • src/content/docs/cloudflare-agent/index.mdx:1 — Missing description in frontmatter (recommended for SEO).
  • src/content/docs/cloudflare-agent/index.mdx:50 — List items under "Network diagnostics" use bare hyphens as separators; em dashes or full sentences would be more consistent with the style guide.
  • src/icons/cloudflare-agent.svg:1 — Missing trailing newline.

The content itself is well-structured — correct pcx_content_type, valid AI tag, proper component import, sequential headings, and correct internal link format. The CODEOWNERS and labeler changes look good (noting kodster28's existing suggestion to add the @cloudflare/pcx-technical-writing team, which has already been addressed in the current state).

github run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants