How to Update Documentations

All documentation updates are done through Claude. A one-time setup prompt gets the repo on your machine — after that, just tell Claude what you need and it handles the rest.

Preview Branches

Every change starts on a preview branch. Push to preview/<name> and it automatically deploys to a shareable URL:

https://docs.nvq2.ovp.kaltura.com/preview/<name>/docs/...

Coming soon: Automated review agents for marketing, security, and quality will scan preview deployments and provide feedback before changes are promoted to production.

Before You Start

We recommend reading these guides first:

How Documentations Are Structured — the minisite approach and build pipeline
Documentation Sources — the different source types
Platform Content Registry — for auto-generated content

Getting Started

First time? Clone the repo

If you haven't cloned the repository yet, copy this prompt into Claude — it will clone the repo, install dependencies, and verify the build:

Fetch and follow instructions from https://docs.nvq2.ovp.kaltura.com/assets/initial-setup.md

Starting a new preview?

If you already have the repo and want to start a new documentation change, copy this prompt into Claude — it will ask you for a preview name, create a branch, and get you started:

Fetch and follow instructions from https://docs.nvq2.ovp.kaltura.com/assets/start-fresh.md

The preview name becomes part of the URL — e.g. player-sdk-docs → preview/player-sdk-docs

Continuing an existing preview?

If you've already started a preview branch and want to pick up where you left off, copy this prompt into Claude — it will find your branch, handle any uncommitted work, and pull the latest changes:

Fetch and follow instructions from https://docs.nvq2.ovp.kaltura.com/assets/update-existing-preview.md

Making Changes

Open Claude in the repository directory and describe what you want to do. For example:

"Create a new minisite for the Player SDK under the Video category"
"Add a getting-started page to the Intelligent Agents SDK minisite"
"Update the overview page in the MCP Server minisite"

Claude knows the repository structure and will walk you through branching, editing, building, and publishing — no additional prompts needed.

Preview changes locally

Start a local dev server so you can see your changes in the browser as you work:

Start a local server of the documentation

This opens the site at http://localhost:3000. Changes rebuild automatically as you edit.

Editing a specific page

The most precise way to tell Claude what to change:

With the local server running, navigate to the page you want to edit in your browser.
Copy the page URL (e.g. http://localhost:3000/docs/agents-avatars/intelligent-agents-sdk/use-cases) and paste it into Claude along with your instructions.
To target a specific section — hover over any section heading in the browser to reveal a # link icon, click it, then copy the updated URL which now includes the section anchor.

Example: "On http://localhost:3000/docs/.../use-cases#authentication — rewrite this section to include the new OAuth flow"

Saving your progress

You don't have to finish everything in one session. Save your work at any point:

Commit all changes

This commits and pushes your changes to the remote branch, triggering a preview deployment. If you're not ready to deploy yet and just want a local save:

Commit all changes without pushing to the server

Submitting for review

When you're happy with your changes and ready for others to review:

Commit and push changes and create a PR if not exists or update existing one

Claude will commit any outstanding changes, push to the remote, and either create a new pull request or update the existing one. The PR will include a link to the preview deployment.