Docs reorg - #703
Merged
Merged
Conversation
Restructure navigation from 7 content-type tabs (Getting Started, Guides, Server APIs, Client SDKs, CLI, Deployment, Examples) to 6 product-oriented tabs (Overview, Pipecat, Pipecat Clients, Pipecat Subagents, Pipecat Cloud, API Reference). New pages: - Overview tab: introduction, pipecat, clients, subagents, cloud - Pipecat Subagents tab: introduction, quickstart, architecture, agent-types, tasks - Pipecat Clients tab: voice-ui-kit Updated pages: - server/introduction.mdx reframed as Pipecat product landing page - getting-started/next-steps.mdx updated deployment links - Client SDK intros (JS, React Native, iOS, Android) updated with cross-links to API Reference tab Navigation fixes: - Added orphaned pages to nav (gradium STT/TTS, google-rtvi-observer) - Added redirects for removed pages (getting-started/introduction, getting-started/ecosystem, deployment/platforms/pipecat-cloud) - Removed empty stubs (serializers/telnyx, serializers/twilio, c++/api-reference)
Move all Pipecat tab pages into a unified pipecat/ directory tree: - get-started/ (introduction, quickstart, build-your-next-bot, ai-tools, next-steps) - learn/ (12 learning guides) - fundamentals/ (11 guides + evaluations/) - features/ (5 feature guides) - telephony/ (8 telephony guides) - deployment/ (overview, pattern, platforms/, images/) - examples/ (overview, recipes) Update all cross-references across 130+ files and add redirects for every moved path to preserve existing links.
Promote deployment/pipecat-cloud/ to a top-level pipecat-cloud/ directory and delete the now-empty deployment/ folder. Update all references in MDX files, OpenAPI JSON specs, and docs.json nav. Add redirects for all old deployment/pipecat-cloud/ paths.
Move pipecat-cloud/images/ into the shared images/ folder and convert all relative image paths to absolute /images/... paths. This makes future page reorganization easier since image references no longer depend on file location.
…guides Delete 6 outdated migration guide pages and move API reference and transport package pages from the API Reference tab into the Pipecat Clients tab so each SDK group has its intro, reference, and transports together.
Split the monolithic Flows guide into focused pages (introduction, quickstart, nodes & messages, functions, actions, context strategies, state management, examples) under a new Pipecat Flows tab. Move reference docs from server/frameworks/flows/ to pipecat-flows/reference/ and keep them in the API Reference tab. Add redirects for all old paths.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
markbackman
force-pushed
the
mb/docs-reorg
branch
from
April 4, 2026 01:08
15b2ec5 to
bb0c4be
Compare
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
1 participant
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.
Clean up preparing for new things to come!