wehub-resource-sync
91e75e620b
CI: cua-driver distro-compat matrix / Resolve release version (push) Waiting to run
CI: cua-driver distro-compat matrix / debian:12 (glibc 2.36) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / fedora:41 (glibc 2.40) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / rockylinux:9 (glibc 2.34) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / ubuntu:22.04 (glibc 2.35) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / ubuntu:24.04 (glibc 2.39) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / Distro compat summary (push) Blocked by required conditions
CI: Nix Linux Rust source / Nix / compositor build (push) Waiting to run
CI: Nix Linux Rust source / Nix / driver package (push) Waiting to run
CI: Nix Linux Rust source / Nix / Rust unit tests (push) Waiting to run
CI: Rust Linux unit / Rust Linux unit and compile (push) Waiting to run
CI: Rust Windows unit / Rust Windows unit and compile (push) Waiting to run
CI: SPDX Headers / Check SPDX headers (warn-only) (push) Waiting to run
CD: Docs MCP Server / build (linux/amd64) (push) Waiting to run
CD: Docs MCP Server / build (linux/arm64) (push) Waiting to run
CD: Docs MCP Server / merge (push) Blocked by required conditions
41 lines
1.2 KiB
Markdown
41 lines
1.2 KiB
Markdown
# docs
|
|
|
|
Production docs are served from https://cua.ai/docs; this app is now a local MDX preview only.
|
|
|
|
Run the local preview:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Open http://localhost:8090 with your browser to see the result.
|
|
|
|
## 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.
|
|
- `explanation/` explains 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.
|
|
|
|
## Setup Telemetry
|
|
|
|
We use PostHog for telemetry to improve the clarity and structure of our documentation. Start by copying the `.env.example` and adding in your PostHog API key and host.
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
## Learn More
|
|
|
|
To learn more about Next.js and Fumadocs, take a look at the following
|
|
resources:
|
|
|
|
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
|
|
features and API.
|
|
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
|
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs
|