Skip to content

Restructured docs to diataxis#72

Merged
sawradip merged 13 commits into
mainfrom
sawr/docs_to_diataxis
Oct 2, 2025
Merged

Restructured docs to diataxis#72
sawradip merged 13 commits into
mainfrom
sawr/docs_to_diataxis

Conversation

@sawradip
Copy link
Copy Markdown
Contributor

@sawradip sawradip commented Oct 2, 2025

Summary by CodeRabbit

  • Documentation

    • Major docs restructure with new tabs: Explanation, How-to Guides, Reference, Resources, and Tutorials.
    • Added key pages: Core Concepts, Architecture, Security, Production Considerations, Roadmap, Quickstart Map, and overviews.
    • New how-to guides for calling from Python, JavaScript, Go, and Rust; framework guides (LangGraph, CrewAI, Letta, Agno); and tutorials (Customer Support, Internal Q&A, Multi-language Wrapper).
    • Introduced contextual “NeedHelp” snippets across pages.
    • Removed outdated SDK/framework docs and examples.
  • Chores

    • Updated docs dev setup: switched Node image and set Mintlify dev to port 3333.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Oct 2, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This PR restructures documentation: new “Explanation,” “How-to,” “Tutorials,” and consolidated “Reference” sections; moves framework guides under how-to; adds multiple new guides and tutorials; removes several legacy SDK/framework docs; injects a NeedHelp snippet across pages; updates docs navigation and Docker dev config.

Changes

Cohort / File(s) Summary of changes
Docs navigation restructure
docs/docs.json
Reorganized tabs/groups and paths into Introduction, Tutorials, How-to Guides, Reference, Explanation, and Resources; updated routes and group names.
Docker dev config
docs/docker-compose.yml
Switched image to node:24-alpine3.21; set mintlify dev to run on port 3333.
NeedHelp snippet integration
docs/snippets/need-help.mdx, docs/api-reference/introduction.mdx, docs/cli/overview.mdx, docs/explanation/*...*.mdx, docs/resources/faq.mdx, docs/resources/overview.mdx, docs/reference/overview.mdx, docs/sdk/overview.mdx, docs/tutorials/deploy-your-first-agent.mdx, docs/tutorials/overview.mdx
Added reusable help Card snippet and imported/rendered it across many pages; minor structural adjustments where inserted.
Explanation: new/expanded content
docs/explanation/architecture-overview.mdx, .../changelog.mdx, .../core-concepts.mdx, .../feature-overview.mdx, .../frameworks-overview.mdx, .../installation.mdx, .../introduction.mdx, .../key-concepts-at-a-glance.mdx, .../overview.mdx, .../production-considerations.mdx, .../quickstart-map.mdx, .../roadmap.mdx, .../security.mdx, .../why-runagent.mdx
Added or revised pages with detailed conceptual, architectural, security, roadmap, and overview content; updated assets/links; inserted NeedHelp where applicable.
How-to: language guides
docs/how-to/call-from-python.mdx, .../call-from-javascript.mdx, .../call-from-go.mdx, .../call-from-rust.mdx
Added comprehensive how-to guides for calling agents from Python, JS, Go, and Rust, including streaming, errors, patterns, and testing.
How-to: frameworks
docs/how-to/frameworks/agno.mdx, .../crewai.mdx, .../custom.mdx, .../langgraph.mdx, .../letta.mdx
Added detailed integration guides for Agno, CrewAI, Custom, LangGraph, and Letta with code samples and configurations.
How-to: overview and advanced
docs/how-to/overview.mdx, docs/how-to/advanced-tasks.mdx
Added overview landing and placeholder advanced tasks page with links to current resources.
Tutorials: new content
docs/tutorials/customer-support-agent.mdx, docs/tutorials/internal-qa-agent.mdx, docs/tutorials/multi-language-wrapper.mdx, docs/tutorials/overview.mdx
Added step-by-step tutorials with sample agents, streaming flows, configs, clients, and UI snippets.
Tutorial update
docs/tutorials/deploy-your-first-agent.mdx
Updated card hrefs; added NeedHelp component; minor formatting.
SDK docs: additions
docs/sdk/javascript/getting-started.mdx, docs/sdk/overview.mdx
Added JS SDK getting started; appended NeedHelp to SDK overview.
SDK docs: removals (Go/Rust/TS legacy)
docs/sdk/go/*, docs/sdk/rust/*, docs/sdk/typescript/*
Removed multiple legacy SDK example/reference pages for Go, Rust, and TypeScript.
Frameworks (legacy) removals
docs/frameworks/agno.mdx, .../crewai.mdx, .../custom.mdx, .../langgraph.mdx, .../letta.mdx
Deleted old framework docs superseded by How-to framework guides.
Resources: new/updated
docs/resources/overview.mdx, docs/resources/faq.mdx
Added Resources overview page; injected NeedHelp into FAQ.
API/CLI page tweaks
docs/api-reference/introduction.mdx, docs/cli/overview.mdx
Imported and rendered NeedHelp; minor structural adjustments around component blocks.
Examples removal
docs/examples/overview.mdx
Deleted Examples overview content.
Snippet removal
docs/snippets/snippet-intro.mdx
Removed snippet intro content.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Client (SDK/HTTP)
  participant GW as API Gateway
  participant AM as Agent Manager
  participant VM as Agent MicroVM
  participant DS as Data Store

  Dev->>GW: Invoke entrypoint (JSON payload)
  GW->>AM: Resolve agent/tag and resources
  AM->>VM: Provision/route to sandbox
  VM->>DS: Optional fetch/config/state
  VM-->>GW: Result stream (chunks)
  GW-->>Dev: Stream to client (WS/HTTP SSE)
  alt Error
    VM-->>GW: Error details
    GW-->>Dev: Structured error response
  end
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Poem

Thump-thump, new paths in docs I weave,
Cards and streams tucked up my sleeve.
Frameworks hop to how-to glades,
Roadmaps bloom in pastel shades.
NeedHelp signs along the trail—
Follow me; you won’t derail.
Ship it swift—then nibble kale.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sawr/docs_to_diataxis

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b057239 and 5c79ebc.

📒 Files selected for processing (62)
  • docs/api-reference/introduction.mdx (2 hunks)
  • docs/cli/overview.mdx (2 hunks)
  • docs/docker-compose.yml (1 hunks)
  • docs/docs.json (3 hunks)
  • docs/examples/overview.mdx (0 hunks)
  • docs/explanation/architecture-overview.mdx (1 hunks)
  • docs/explanation/changelog.mdx (1 hunks)
  • docs/explanation/core-concepts.mdx (1 hunks)
  • docs/explanation/feature-overview.mdx (1 hunks)
  • docs/explanation/frameworks-overview.mdx (2 hunks)
  • docs/explanation/installation.mdx (2 hunks)
  • docs/explanation/introduction.mdx (10 hunks)
  • docs/explanation/key-concepts-at-a-glance.mdx (1 hunks)
  • docs/explanation/overview.mdx (1 hunks)
  • docs/explanation/production-considerations.mdx (1 hunks)
  • docs/explanation/quickstart-map.mdx (1 hunks)
  • docs/explanation/roadmap.mdx (1 hunks)
  • docs/explanation/security.mdx (1 hunks)
  • docs/explanation/why-runagent.mdx (1 hunks)
  • docs/frameworks/agno.mdx (0 hunks)
  • docs/frameworks/crewai.mdx (0 hunks)
  • docs/frameworks/custom.mdx (0 hunks)
  • docs/frameworks/langgraph.mdx (0 hunks)
  • docs/frameworks/letta.mdx (0 hunks)
  • docs/get-started/core-concepts.mdx (0 hunks)
  • docs/how-to/advanced-tasks.mdx (1 hunks)
  • docs/how-to/call-from-go.mdx (1 hunks)
  • docs/how-to/call-from-javascript.mdx (1 hunks)
  • docs/how-to/call-from-python.mdx (1 hunks)
  • docs/how-to/call-from-rust.mdx (1 hunks)
  • docs/how-to/frameworks/agno.mdx (1 hunks)
  • docs/how-to/frameworks/crewai.mdx (1 hunks)
  • docs/how-to/frameworks/custom.mdx (1 hunks)
  • docs/how-to/frameworks/langgraph.mdx (1 hunks)
  • docs/how-to/frameworks/letta.mdx (1 hunks)
  • docs/how-to/overview.mdx (1 hunks)
  • docs/reference/overview.mdx (1 hunks)
  • docs/resources/faq.mdx (2 hunks)
  • docs/resources/overview.mdx (1 hunks)
  • docs/sdk/coming-soon.mdx (0 hunks)
  • docs/sdk/go/ag2_agno.mdx (0 hunks)
  • docs/sdk/go/autogen.mdx (0 hunks)
  • docs/sdk/go/crewai.mdx (0 hunks)
  • docs/sdk/go/langgraph.mdx (0 hunks)
  • docs/sdk/javascript/getting-started.mdx (1 hunks)
  • docs/sdk/overview.mdx (2 hunks)
  • docs/sdk/rust/api-reference.mdx (0 hunks)
  • docs/sdk/rust/async-operations.mdx (0 hunks)
  • docs/sdk/rust/local-server.mdx (0 hunks)
  • docs/sdk/rust/streaming.mdx (0 hunks)
  • docs/sdk/typescript/ag2_agno.mdx (0 hunks)
  • docs/sdk/typescript/autogen.mdx (0 hunks)
  • docs/sdk/typescript/crewai.mdx (0 hunks)
  • docs/sdk/typescript/getting-started.mdx (0 hunks)
  • docs/sdk/typescript/langgraph.mdx (0 hunks)
  • docs/snippets/need-help.mdx (1 hunks)
  • docs/snippets/snippet-intro.mdx (0 hunks)
  • docs/tutorials/customer-support-agent.mdx (1 hunks)
  • docs/tutorials/deploy-your-first-agent.mdx (3 hunks)
  • docs/tutorials/internal-qa-agent.mdx (1 hunks)
  • docs/tutorials/multi-language-wrapper.mdx (1 hunks)
  • docs/tutorials/overview.mdx (1 hunks)

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 and usage tips.

@sawradip sawradip changed the title Sawr/docs to diataxis Restructured docs to diataxis Oct 2, 2025
@sawradip sawradip merged commit c7fea99 into main Oct 2, 2025
1 of 2 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Oct 8, 2025
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