Skip to content

Fce 3087 reorganize docs#247

Open
roznawsk wants to merge 6 commits intomainfrom
FCE-3087-vapi-docs
Open

Fce 3087 reorganize docs#247
roznawsk wants to merge 6 commits intomainfrom
FCE-3087-vapi-docs

Conversation

@roznawsk
Copy link
Copy Markdown
Member

@roznawsk roznawsk commented Apr 10, 2026

Reorganized documentation

  • renamed Explanations to Concepts
  • renamed Concepts/Room types explained to Rooms
  • renamed Concepts/Private vs Public Livestreams to Livestreams
  • removed How-to Guides/Features -> contains sections moved either to How-to Guides/Web & Mobile or How-to Guides/Backend
  • removed Troubleshooting section from How-to Guides -> moved the Video Codecs section to
  • moved Tutorials/Gemini Live integration to new section Integrations/ (setting up for the new VAPI section coming in another PR)

Also

  • updated docusaurus
  • updated packages
image

@linear
Copy link
Copy Markdown

linear bot commented Apr 10, 2026

@roznawsk roznawsk requested a review from Copilot April 10, 2026 10:00
@roznawsk roznawsk changed the title Fce 3087 reoranize docs Fce 3087 reorganize docs Apr 10, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Reorganizes the documentation information architecture (new “Integrations” section, dissolving “Features”, renaming “Explanation” → “Concepts”) and updates the published API specs/config to match the new structure and upcoming server features.

Changes:

  • Add doc-site redirects for moved pages and wire them into Docusaurus.
  • Update OpenAPI + protobuf specs (new track forwarding concepts, new peer type/options, response wrapper schemas).
  • Restructure docs navigation/content (new Integrations category, moved/renamed pages, updated internal links, consolidated video codec guidance).

Reviewed changes

Copilot reviewed 38 out of 39 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
static/api/protobuf/server_notifications.proto Adds track-forwarding server notification messages and reorganizes oneof content (incl. deprecations).
static/api/fishjam-server-openapi.yaml Updates server OpenAPI schemas/paths (peer types/options, details responses, track forwarding endpoint, room composition info).
redirects/index.ts Implements version-aware redirect generation for moved docs pages.
package.json Bumps Docusaurus deps, adds client-redirects plugin and new UI dependency, updates Yarn version.
docusaurus.config.ts Wires redirects plugin, adjusts markdown/bundler future settings, updates doc ignore/search exclusions to include Integrations.
docs/tutorials/react-quick-start.mdx Renames link text to “Rooms”.
docs/tutorials/react-native-quick-start.mdx Renames link text to “Rooms”.
docs/tutorials/livestreaming.mdx Updates links to new how-to locations and renamed concept pages.
docs/tutorials/backend-quick-start.mdx Renames link text to “Rooms”.
docs/tutorials/agents.mdx Updates selective-subscriptions links to new location.
docs/integrations/gemini-live-integration.mdx Adjusts frontmatter/positioning for new Integrations section.
docs/integrations/category.json Adds Integrations category metadata and generated index.
docs/how-to/troubleshooting/video-codecs.mdx Removes standalone troubleshooting page (content moved elsewhere).
docs/how-to/troubleshooting/category.json Removes Troubleshooting category definition.
docs/how-to/features/category.json Removes Features category definition (section dissolved).
docs/how-to/client/text-chat.mdx Adds sidebar positioning and updates internal links after reorg.
docs/how-to/client/simulcast.mdx Adds sidebar positioning and updates internal links after reorg.
docs/how-to/client/connecting.mdx Updates Sandbox API link to new backend how-to location.
docs/how-to/backend/whip-whep.mdx Adds sidebar positioning and updates links to renamed/moved concept/how-to pages.
docs/how-to/backend/selective-subscriptions.mdx Adds sidebar positioning and updates link text to “Rooms”.
docs/how-to/backend/sandbox-api-testing.mdx Adds sidebar positioning and updates relative link to backend setup page.
docs/how-to/backend/fastify-example.mdx Adjusts sidebar positioning.
docs/how-to/backend/audio-only-calls.mdx Adds sidebar positioning and updates links to match new structure.
docs/explanation/what-is-fishjam.mdx Renames link text to “Rooms”.
docs/explanation/simulcast.mdx Updates simulcast how-to link to new client section path.
docs/explanation/security-tokens.mdx Adjusts sidebar positioning.
docs/explanation/sandbox-api-concept.mdx Updates Sandbox API how-to link to new backend location.
docs/explanation/room-types.mdx Renames page to “Rooms” and absorbs video codec guidance; updates links to new how-to locations.
docs/explanation/public-livestreams.mdx Renames page to “Livestreams” and updates WHIP/WHEP links to new backend how-to location.
docs/explanation/glossary.md Updates Sandbox API link to new backend location.
docs/explanation/data-channels.mdx Updates Text Chat link to new client how-to location.
docs/explanation/architecture.mdx Renames link text to “Rooms”.
docs/explanation/agent-internals.mdx Adjusts sidebar positioning.
docs/explanation/category.json Renames sidebar category “Explanation” → “Concepts” and updates generated-index title.
docs/examples/react.mdx Updates Sandbox API and Text Chat links to new locations.
docs/examples/react-native.mdx Updates Text Chat link to new client how-to location.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@roznawsk roznawsk marked this pull request as ready for review April 10, 2026 12:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 41 out of 42 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

static/api/fishjam-server-openapi.yaml:48

  • RoomCreateDetailsResponse still lists fishjam_address as required, but the fishjam_address property was removed from data.properties. This makes the OpenAPI schema invalid and can break codegen/validation. Either add the property back or remove it from the required list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Member

@PiotrWodecki PiotrWodecki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checks, but good changes

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.

3 participants