Skip to content

Latest commit

 

History

History
 
 

README.md

docs

Public documentation content and assets live in this repository. The production renderer, redirects, analytics, and site configuration live in trycua/cloud. This app is a local MDX preview for contributors to the public repository.

Install the docs dependencies and run the local preview from this directory:

pnpm install --frozen-lockfile
pnpm dev

Open http://localhost:8090 with your browser to see the result. The docs app has its own lockfile; installing dependencies at the repository root is not enough.

Validate a change

Curated MDX pages use the content checks and production build:

pnpm docs:check-hygiene
pnpm docs:check-links
pnpm build

For generated reference changes, also run the owning component check:

pnpm docs:check:cua-driver
pnpm docs:check:lume

pnpm docs:generate:cua-driver regenerates the shared CLI reference and only the host's native reference: mcp-tools-linux.mdx on Linux, mcp-tools.mdx on macOS, and mcp-tools-windows.mdx on Windows. The existing macOS URL and anchors are preserved. The corresponding check compares those same two files without writing them. Shared guidance stays in the hand-maintained mcp-tool-notes.mdx. Use the native reference for the machine running the driver, not the agent's machine. The generator omits CUA_DRIVER_POLICY_FILE and CUA_DRIVER_MANAGED_POLICY_FILE only from its finite dump-docs child process so the reference includes every registered native tool. It does not change policy files, the parent environment, normal tool discovery, or action authorization.

Native generation requires Rust and the component's native build dependencies. Lume generation and checking require macOS. pnpm docs:check remains the explicit full Cua Driver and Lume audit, not a portable curated-page check. On Windows, install the Rust MSVC toolchain and Visual Studio C++ Build Tools with a Windows SDK and MSVC Spectre-mitigated libraries. These commands work from PowerShell or Command Prompt; Git Bash is not required.

Docs conventions

Public docs live in content/docs/ and follow the Diátaxis modes:

  • tutorials/ teach a guided first success.
  • how-to-guides/ give steps for a specific goal.
  • concepts/ contains Diátaxis explanations of concepts, constraints, and tradeoffs.
  • reference/ is dry lookup: commands, APIs, contracts, limits.

Place content by what the reader is trying to do, not by topic. Do not mix modes in one page; move reference tables to reference pages and link to them from how-to guides or explanations.

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources: