OpenParable
Skip to content
← Back to skills

Docs

Development
docs

Docs is an Agent Skill for development published in the remotion-dev/remotion repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Start the Remotion docs site and open it in the Codex browser. Use when the user invokes /docs or $docs, asks to launch the local documentation site, or wants to preview docs changes in Docusaurus.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/remotion-dev/remotion/blob/HEAD/.agents/skills/docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/docs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Docs Site

Overview

Prepare the Remotion monorepo, launch the Docusaurus docs site, and open the served URL in the Codex in-app browser.

Workflow

  1. From the repository root, run:
bun i && bun run build
  1. Start the docs site:
cd packages/docs && bun run start
  1. Keep the server process running and read its output for the local URL. The expected default is http://localhost:3000, but follow the printed URL if Docusaurus chooses or reports another port.
  2. Open the URL in the Codex in-app browser. If no browser tool is available yet, use tool_search for the in-app browser control tool, then navigate to the local URL.
  3. Tell the user the docs URL and whether this is a newly started or already running server.