Skip to content

docs(docs): restructure docs for the agent-platform pivot (v1.0 archive) - #5517

Draft
mmabrouk wants to merge 1 commit into
mainfrom
docs/agent-platform-rework
Draft

docs(docs): restructure docs for the agent-platform pivot (v1.0 archive)#5517
mmabrouk wants to merge 1 commit into
mainfrom
docs/agent-platform-rework

Conversation

@mmabrouk

Copy link
Copy Markdown
Member

What this does

Restructures the documentation for the pivot to an agent platform. It archives the previous product's docs as a browsable version 1.0 and refocuses the current docs on agents, without breaking a single existing URL.

The version split

  • The current docs are v2.0 and keep their existing URLs.
  • The previous product's docs are frozen as v1.0 under /1.0/: prompt management, evaluation, observability, custom workflows, concepts, the framework integrations, tutorials, and the Python SDK reference.
  • A small version pill sits next to the logo and switches between the two. v1.0 pages carry an automatic "no longer maintained" banner.
  • One createRedirects rule forwards every old URL (for example /observability/overview) to its /1.0/ page, so old links and search results keep working. The last build produced 185 redirect pages.

Navigation and content

  • Tutorials and Integrations are hidden from the top navigation. Their pages still build and stay reachable by URL.
  • The overview page loses the walkthrough video.
  • The outdated TypeScript FAQ is removed, along with its card and links.
  • Two contributing pages (filing an issue, community projects) are removed.

Corrected against the source code

Each of these was verified against the code, not the old page:

  • Data retention: the old table overstated retention by up to four times and used a plan name that does not exist. Now states the real per-plan values and that self-hosted deployments have no retention limit.
  • Open source vs commercial: role-based access control was in the wrong column, audit logs were missing, and the page wrongly claimed the whole public repo is MIT. Corrected.
  • API rate limits: wrong numbers and stale endpoints; now states the real limits and that they do not apply to self-hosted.
  • LLM providers: corrected the built-in provider list.
  • Contributing guides (testing, development mode, formatting): fixed dead install commands, wrong flags, and the moved SDK path.

REST API reference

Regenerated from the production OpenAPI spec. It grows from 410 to 512 endpoints and adds the Mounts, Sessions, and Triggers groups. This is the bulk of the file count.

Roadmap

Refocused on agent-platform work: four in-progress items and five planned, each linked to a tracking issue. The GitHub discussions list is hidden behind a flag (SHOW_DISCUSSIONS) rather than deleted, and the request-a-feature button stays.

Build tooling

docusaurus-plugin-llms-txt is patched to tolerate hidden and versioned sidebars, which the versioning change requires.

How to review

  • The two-version behaviour is easiest to see live: switch the version pill, then open a v1.0 page and confirm the banner and the redirect from the old URL.
  • The roadmap change is contained in docs/src/data/roadmap.ts.
  • The ~600 files under docs/docs/reference/api/ are mechanical regen output; review the prose pages instead.

Notes

  • Committed from a clean worktree off main to keep it separate from other in-flight work.
  • Draft: not for merge yet. A few follow-ups are still open (a changelog entry for "creating agents from the UI", and the roadmap label colours).

Archive the previous product's documentation as version 1.0 and refocus the
current docs on the agent platform.

- Add Docusaurus versioning: current docs are v2.0 and keep their URLs; the
  previous product (prompt management, evaluation, observability, custom
  workflows, concepts, integrations, tutorials, Python SDK reference) is frozen
  as v1.0 under /1.0/. A version pill next to the logo switches between them.
- Redirect every old URL to its /1.0/ page so existing links and search results
  keep working.
- Hide Tutorials and Integrations from the top navigation.
- Regenerate the REST API reference from the production OpenAPI spec (adds the
  Mounts, Sessions, and Triggers endpoint groups).
- Refocus the roadmap on agent-platform work; hide the GitHub discussions list
  behind a flag and keep the request-a-feature button.
- Correct pages against the source: data retention, open source vs commercial,
  API rate limits, LLM providers, the testing / development-mode / formatting
  contributing guides.
- Remove the video from the overview page and the outdated TypeScript FAQ.
- Patch docusaurus-plugin-llms-txt to tolerate hidden and versioned sidebars.
@vercel

vercel Bot commented Jul 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agenta-documentation Error Error Jul 25, 2026 6:18pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 587e4c22-5bc3-4b53-9886-39b11291cdda

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agent-platform-rework

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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