docs(docs): restructure docs for the agent-platform pivot (v1.0 archive) - #5517
Draft
mmabrouk wants to merge 1 commit into
Draft
docs(docs): restructure docs for the agent-platform pivot (v1.0 archive)#5517mmabrouk wants to merge 1 commit into
mmabrouk wants to merge 1 commit into
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
/1.0/: prompt management, evaluation, observability, custom workflows, concepts, the framework integrations, tutorials, and the Python SDK reference.createRedirectsrule 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
Corrected against the source code
Each of these was verified against the code, not the old page:
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-txtis patched to tolerate hidden and versioned sidebars, which the versioning change requires.How to review
docs/src/data/roadmap.ts.docs/docs/reference/api/are mechanical regen output; review the prose pages instead.Notes
mainto keep it separate from other in-flight work.