Skip to content

Fce 2713 add llms.txt#239

Merged
PiotrWodecki merged 5 commits intomainfrom
fce-2713-add-llms
Mar 17, 2026
Merged

Fce 2713 add llms.txt#239
PiotrWodecki merged 5 commits intomainfrom
fce-2713-add-llms

Conversation

@PiotrWodecki
Copy link
Member

@PiotrWodecki PiotrWodecki commented Mar 16, 2026

  • Adds llms.txt to docs under /docs/docs/llms.txt
  • path is unfixable without forking the plugin, but we don't care about that, as we are going to proxy it under the landing page anyway: fishjam.swmansion.com/llms.txt
  • Added titles and descriptions for better llms.txt generation
  • Another PR will include more content from the landing page

@linear
Copy link

linear bot commented Mar 16, 2026

@PiotrWodecki PiotrWodecki self-assigned this Mar 16, 2026
@PiotrWodecki PiotrWodecki requested a review from Copilot March 16, 2026 15:20
@PiotrWodecki PiotrWodecki marked this pull request as ready for review March 16, 2026 15:23
@PiotrWodecki PiotrWodecki changed the title Fce 2713 add llms Fce 2713 add llms.txt Mar 16, 2026
Copy link
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

This PR integrates docusaurus-plugin-llms into the Fishjam Docusaurus site and enriches documentation frontmatter (titles/descriptions) to improve generated llms.txt content for LLM-friendly indexing.

Changes:

  • Add docusaurus-plugin-llms dependency and configure it in docusaurus.config.ts to generate llms.txt and llms-full.txt.
  • Update many docs pages to include frontmatter description (and in a few cases title) to improve LLMs output quality/metadata.
  • Update lockfile to include the new plugin and its transitive dependencies.

Reviewed changes

Copilot reviewed 33 out of 34 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
yarn.lock Adds lock entries for docusaurus-plugin-llms and transitive deps (e.g., yaml, minimatch).
package.json Adds docusaurus-plugin-llms to devDependencies.
docusaurus.config.ts Configures docusaurus-plugin-llms generation and ordering/ignore settings.
docs/tutorials/react-quick-start.mdx Adds page meta description.
docs/tutorials/react-native-quick-start.mdx Adds page meta description.
docs/tutorials/livestreaming.mdx Adds page meta description.
docs/tutorials/gemini-live-integration.mdx Adds page meta description.
docs/tutorials/backend-quick-start.mdx Adds page meta description.
docs/tutorials/agents.mdx Adds page meta description.
docs/how-to/features/whip-whep.mdx Adds page meta description.
docs/how-to/features/text-chat.mdx Adds page meta description.
docs/how-to/features/selective-subscriptions.mdx Adds page meta description.
docs/how-to/features/sandbox-api-testing.mdx Adds page meta description.
docs/how-to/features/audio-only-calls.mdx Adds page meta description.
docs/how-to/client/stream-middleware.mdx Adds explicit title + meta description.
docs/how-to/client/start-streaming.mdx Adds page meta description.
docs/how-to/client/screensharing.mdx Adds explicit title + meta description.
docs/how-to/client/reconnection-handling.mdx Adds explicit title + meta description.
docs/how-to/client/picture-in-picture.mdx Adds explicit title + meta description.
docs/how-to/client/migration-guide.mdx Adds explicit title.
docs/how-to/client/managing-devices.mdx Adds page meta description.
docs/how-to/client/list-other-peers.mdx Adds page meta description.
docs/how-to/client/installation.mdx Adds page meta description.
docs/how-to/client/debug-logging.mdx Adds explicit title + meta description.
docs/how-to/client/custom-sources.mdx Adds explicit title + meta description.
docs/how-to/client/connecting.mdx Adds page meta description.
docs/how-to/client/background-streaming.mdx Adds explicit title + meta description.
docs/how-to/backend/server-setup.mdx Adds page meta description.
docs/how-to/backend/production-deployment.mdx Adds page meta description.
docs/how-to/backend/fastify-example.mdx Adds page meta description.
docs/how-to/backend/fastapi-example.mdx Adds page meta description.
docs/explanation/public-livestreams.mdx Adds page meta description.
docs/explanation/data-channels.mdx Adds page meta description.
docs/explanation/agent-internals.mdx Adds page meta description.

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

You can also share your feedback on Copilot code review. Take the survey.

@PiotrWodecki PiotrWodecki requested review from AHGIJMKLKKZNPJKQR and czerwiukk and removed request for czerwiukk March 17, 2026 08:39
Copy link
Member

@AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR left a comment

Choose a reason for hiding this comment

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

is the llms.txt not commited to the repo?

@PiotrWodecki
Copy link
Member Author

is the llms.txt not commited to the repo?

it is autogenerated on build

@PiotrWodecki
Copy link
Member Author

current status:

# Fishjam Docs

> Fishjam is a multimedia streaming toolkit for building real-time video and audio applications with managed WebRTC infrastructure, client SDKs (React, React Native), and server SDKs (Node.js, Python).

Curated index of Fishjam documentation. Start with Tutorials for quick starts, Explanation for concepts, How-to for guides, and API for SDK references.

## Table of Contents

- [Agents](https://documentation.fishjam.io/docs/tutorials/agents): Introduction to Fishjam agents and how to implement them using server SDKs.
- [Backend Quick Start](https://documentation.fishjam.io/docs/tutorials/backend-quick-start): Set up a backend server to create rooms and manage peers for your Fishjam application.
- [Gemini Live Integration](https://documentation.fishjam.io/docs/tutorials/gemini-live-integration): Build a real-time speech-to-speech voice assistant using Fishjam and Google's Multimodal Live API.
- [Livestreaming](https://documentation.fishjam.io/docs/tutorials/livestreaming): Set up livestreaming with Fishjam, from sandbox prototyping to production deployment with server SDKs.
- [React Native Quick Start](https://documentation.fishjam.io/docs/tutorials/react-native-quick-start): Step-by-step guide to integrating Fishjam into a React Native application with a working video streaming app.
- [React/Web Quick Start](https://documentation.fishjam.io/docs/tutorials/react-quick-start): Step-by-step guide to integrating Fishjam into a React web application with a working video streaming app.
- [FastAPI](https://documentation.fishjam.io/docs/how-to/backend/fastapi-example): Example FastAPI server integration using the Fishjam Python SDK.
- [Fastify](https://documentation.fishjam.io/docs/how-to/backend/fastify-example): Example Fastify server integration using the Fishjam Node.js SDK.
- [How to Deploy Fishjam to Production](https://documentation.fishjam.io/docs/how-to/backend/production-deployment): Deploy your Fishjam backend safely to production, moving from sandbox to a production-ready setup.
- [Set up your server](https://documentation.fishjam.io/docs/how-to/backend/server-setup): Install and configure a Fishjam server SDK for Node.js or Python, or integrate via the bare REST API.
- [Background calls](https://documentation.fishjam.io/docs/how-to/client/background-streaming): Enable calls running in the background on Android and iOS in React Native applications.
- [Connecting](https://documentation.fishjam.io/docs/how-to/client/connecting): Connect to a Fishjam room using a peer token and room URL obtained from your backend.
- [Custom sources](https://documentation.fishjam.io/docs/how-to/client/custom-sources): Stream non-standard video or audio sources (e.g. WebGL, WebGPU, Three.js) through Fishjam in web apps.
- [Debug logging](https://documentation.fishjam.io/docs/how-to/client/debug-logging): Enable SDK debug logging to troubleshoot connectivity and media issues in web applications.
- [Installation](https://documentation.fishjam.io/docs/how-to/client/installation): Install the Fishjam client SDK for React (web) or React Native (mobile).
- [Display media of other peers](https://documentation.fishjam.io/docs/how-to/client/list-other-peers): Access and display media tracks from other peers and the local peer using the usePeers hook.
- [Managing devices](https://documentation.fishjam.io/docs/how-to/client/managing-devices): Select, switch, mute, and dynamically control camera and microphone devices.
- [Metadata](https://documentation.fishjam.io/docs/how-to/client/metadata): How to use metadata
- [0.25.x Migration Guide](https://documentation.fishjam.io/docs/how-to/client/migration-guide): This guide will help you upgrade your React Native application from `@fishjam-cloud/react-native-client@0.24.x` to `@fishjam-cloud/react-native-cli...
- [Picture in Picture](https://documentation.fishjam.io/docs/how-to/client/picture-in-picture): Display video in a floating PiP window when the user backgrounds the app on Android or iOS.
- [Reconnect](https://documentation.fishjam.io/docs/how-to/client/reconnection-handling): Handle automatic reconnection to a Fishjam room after connection loss in React Native apps.
- [Screen sharing](https://documentation.fishjam.io/docs/how-to/client/screensharing): Stream mobile device screen content to other peers in React Native applications.
- [Streaming media](https://documentation.fishjam.io/docs/how-to/client/start-streaming): Initialize camera and microphone access and start streaming media in a Fishjam room.
- [Stream middleware](https://documentation.fishjam.io/docs/how-to/client/stream-middleware): Intercept and transform media tracks before sending them to Fishjam, enabling effects and custom encodings.
- [Audio-only Conferences and Livestreams](https://documentation.fishjam.io/docs/how-to/features/audio-only-calls): Create audio-only rooms and livestreams for voice-only use cases at a discounted cost.
- [Testing with the Sandbox API](https://documentation.fishjam.io/docs/how-to/features/sandbox-api-testing): Use the Sandbox API to create rooms and peers for testing without setting up your own backend server.
- [Selective Subscriptions](https://documentation.fishjam.io/docs/how-to/features/selective-subscriptions): Configure manual subscription mode so your backend controls which peers receive which streams.
- [Text Chat](https://documentation.fishjam.io/docs/how-to/features/text-chat): Implement peer-to-peer text chat in your application using Fishjam data channels.
- [WHIP/WHEP with Fishjam](https://documentation.fishjam.io/docs/how-to/features/whip-whep): Publish and receive Fishjam livestreams directly using the WHIP and WHEP protocols.
- [How to Handle Video Codec Issues](https://documentation.fishjam.io/docs/how-to/troubleshooting/video-codecs): **How-to Guide** - _Solve video codec problems and optimize codec selection_
- [Agent Internals](https://documentation.fishjam.io/docs/explanation/agent-internals): Deep dive into Fishjam agent architecture, lifecycle, and how to integrate without using a server SDK.
- [Fishjam Architecture](https://documentation.fishjam.io/docs/explanation/architecture): _Understanding how Fishjam works under the hood_
- [Data Channels](https://documentation.fishjam.io/docs/explanation/data-channels): Send and receive arbitrary binary data between peers using Fishjam data channels.
- [Glossary](https://documentation.fishjam.io/docs/explanation/glossary): A brief walk-through of the terms we use in the documentation.
- [Private vs Public Livestreams](https://documentation.fishjam.io/docs/explanation/public-livestreams): Understand the difference between private and public livestreams in Fishjam and how to configure them.
- [Room Types Explained](https://documentation.fishjam.io/docs/explanation/room-types): _Understanding different types of rooms and when to use them_
- [What is the Sandbox API?](https://documentation.fishjam.io/docs/explanation/sandbox-api-concept): The Sandbox API is a development tool that simplifies getting started with Fishjam by providing a simple backend for testing, eliminating the need ...
- [Security & Token Model](https://documentation.fishjam.io/docs/explanation/security-tokens): _Understanding Fishjam's security architecture and token system_
- [What is Fishjam?](https://documentation.fishjam.io/docs/explanation/what-is-fishjam): _Understanding the role and purpose of Fishjam_
- [Reference](https://documentation.fishjam.io/docs/api/reference): Describes APIs for direct interaction with Fishjam.
- [@fishjam-cloud/react-native-client](https://documentation.fishjam.io/docs/api/mobile): - [useConnection](functions/useConnection.md)
- [@fishjam-cloud/react-client](https://documentation.fishjam.io/docs/api/web): - [useConnection](functions/useConnection.md)
- [@fishjam-cloud/js-server-sdk](https://documentation.fishjam.io/docs/api/server): - [FishjamClient](classes/FishjamClient.md)

@PiotrWodecki PiotrWodecki merged commit fd2b940 into main Mar 17, 2026
5 checks passed
@PiotrWodecki PiotrWodecki deleted the fce-2713-add-llms branch March 17, 2026 14:00
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.

4 participants