Skip to content

Conversation

@elithrar
Copy link
Collaborator

@elithrar elithrar commented Feb 26, 2025

This PR:

Now

  • Moves the API docs + examples from /agents/examples/* to /agents/api-reference/*
  • Document initial state: cloudflare/agents@ff0679f
  • Adds more API examples under /agents/api-reference/sdk/ - e.g. documenting the class methods in full (need to solve generating this...)
  • Remove redundant .txt links from Reference
  • Add /agents/api-reference/creating-agents/ to cover creation & routing patterns + naming agents + this.name + authentication patterns
  • Provide examples of using different AI providers (direct, Workers AI/AI Gateway, ai SDK
  • HTTP / SSE guide
  • update the API reference and build a way to better regenerate it periodically
  • update the unique agents partial to be clearer / fewer blocks of text
  • Document the @callable RPC decorator - https://x.com/threepointone/status/1900265508596777388
  • changelog

Later

  • Adds a new Quickstart that provides a shorter guide + uses a new C3 template - e.g. npm create cloudflare@latest my-agent -- --type=agent to get started with the basics
  • Adds a new guide (?) that shows how to add Agent powers to an existing Workers project
  • Add new /agents/concepts/patterns doc to show typical patterns? Single shot, long running, agent-per-task, co-ordinator pattern (agents/workflows)
  • Pricing: update DO pricing to talk more about concurrency, how 1 vs 100 vs 1000 requests costs the same in terms of GB-s, and that a DO can run for tens of minutes to hours + persist + reload state - e.g. for long running LLM calls or prompt chaining
  • Add a model routing page at /agents/api-reference/model-routing/

@elithrar elithrar self-assigned this Feb 26, 2025
@github-actions
Copy link
Contributor

Howdy and thanks for contributing to our repo. We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

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

github-actions bot commented Feb 26, 2025

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /agents/examples/browse-the-web/
  • /agents/examples/rag/
  • /agents/examples/run-workflows/
  • /agents/examples/schedule-tasks/
  • /agents/api-reference/sdk/
  • /agents/examples/manage-and-sync-state/
  • /agents/examples/using-ai-models/
  • /agents/examples/websockets/
  • /agents/examples/
  • /agents/examples/build-mcp-server/
  • /agents/platform/llms.txt/

@github-actions
Copy link
Contributor

github-actions bot commented Feb 26, 2025

Preview URL: https://eed1cf60.preview.developers.cloudflare.com
Preview Branch URL: https://agents-fixes-week-1.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/agents/api-reference/agents-api/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/agents-api/
https://developers.cloudflare.com/agents/api-reference/calling-agents/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/calling-agents/
https://developers.cloudflare.com/agents/api-reference/sdk/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/sdk/
https://developers.cloudflare.com/changelog/2025-03-18-npm-i-agents/ https://agents-fixes-week-1.preview.developers.cloudflare.com/changelog/2025-03-18-npm-i-agents/
https://developers.cloudflare.com/agents/api-reference/http-sse/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/http-sse/
https://developers.cloudflare.com/agents/api-reference/store-and-sync-state/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/store-and-sync-state/
https://developers.cloudflare.com/agents/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/
https://developers.cloudflare.com/agents/api-reference/websockets/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/websockets/
https://developers.cloudflare.com/agents/api-reference/using-ai-models/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/using-ai-models/
https://developers.cloudflare.com/changelog/2025-02-25-agents-sdk/ https://agents-fixes-week-1.preview.developers.cloudflare.com/changelog/2025-02-25-agents-sdk/
https://developers.cloudflare.com/agents/examples/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/examples/
https://developers.cloudflare.com/agents/platform/llmstxt/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/platform/llmstxt/
https://developers.cloudflare.com/agents/api-reference/configuration/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/configuration/
https://developers.cloudflare.com/agents/api-reference/rag/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/rag/
https://developers.cloudflare.com/agents/api-reference/ https://agents-fixes-week-1.preview.developers.cloudflare.com/agents/api-reference/

@github-actions github-actions bot added size/l and removed size/m labels Feb 27, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 8, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated navigation and added a quickstart guide for the agents documentation.

  • Moved API docs and examples to a new structure under /agents/api-reference/
  • Added a new Quickstart guide for getting started with agents
  • Enhanced API examples and documentation for better clarity
  • Removed redundant links and updated pricing information

Modified Files

  • src/content/docs/agents/api-reference/configuration.mdx
  • src/content/docs/agents/api-reference/index.mdx
  • src/content/docs/agents/api-reference/sdk.mdx
  • src/content/docs/agents/getting-started/testing-your-agent.mdx
  • src/content/docs/agents/index.mdx
  • src/content/docs/agents/platform/index.mdx
  • src/content/docs/agents/platform/limits.mdx

Added Files

  • src/content/docs/agents/api-reference/calling-agents.mdx
  • src/content/docs/agents/getting-started/quickstart.mdx

Renamed Files

  • src/content/docs/agents/api-reference/browse-the-web.mdx
  • src/content/docs/agents/api-reference/rag.mdx
  • src/content/docs/agents/api-reference/run-workflows.mdx
  • src/content/docs/agents/api-reference/schedule-tasks.mdx
  • src/content/docs/agents/api-reference/store-and-sync-state.mdx
  • src/content/docs/agents/api-reference/using-ai-models.mdx
  • src/content/docs/agents/api-reference/websockets.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@elithrar elithrar force-pushed the agents-fixes-week-1 branch from 7f2ba37 to 9981116 Compare March 17, 2025 19:35
@elithrar elithrar mentioned this pull request Mar 17, 2025
5 tasks
@elithrar elithrar enabled auto-merge (squash) March 18, 2025 11:11
@elithrar elithrar requested a review from rita3ko March 18, 2025 12:12
@elithrar elithrar merged commit a194f50 into production Mar 18, 2025
9 checks passed
@elithrar elithrar deleted the agents-fixes-week-1 branch March 18, 2025 12:13
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* commit

* sidebar ordering

* name

* add API reference

* fix intro

* store and sync state

* SDK ref

* initial state

* fix MDX syntax

* improve API ref

* fix broken link

* re-title

* updates

* fix frontmatter

* calling agents

* updates

* quickstart

* agents

* update

* updates

* fix

* SSE

* sse

* auth

* add redirect

* ok

* unique partial

* headers

* agents docs

* updates

* more

* agents-sdk -> agents

* changelog headers / order

* fix image name

* import Badge

* fix

* IMAGE COMPONENT

* fixed image

* reorder

* update

* update API ref

* update

* update

* \n

* fix example

* ok

* Fix

* example linting

* fix

* fix

* date

* fix

* fix

* ok

* reference

* update

* fix changelog

* fix typo

* ok

* ok

* icon

* ok

* k

* Apply suggestions from code review

Co-authored-by: Jun Lee <[email protected]>

* agents -> agents-sdk elsewhere

---------

Co-authored-by: Jun Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.