Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Documentation site

The public docs at docs.auvy.ai are built from apps/docs/ in the AUVY Synapse monorepo. This page is for anyone editing navigation, MDX, or the bundled OpenAPI file.

​
Layout

PathRole
docs.jsonMintlify config: theme, colors, fonts, navigation.tabs, redirects, navbar, api.baseUrl
style.cssOptional overrides (e.g. code font). Loaded automatically by Mintlify when present.
docs/Home tab MDX (intro, features/overview, getting-started/authentication)
guides/Long-form guides (integrate API, neuron scope, search, integration patterns, delegation)
api-reference/REST reference pages
sdk/TypeScript client
cli-reference/CLI
mcp-reference/Hosted MCP server
developer/Monorepo contributor pages (this tab)
openapi.jsonOpenAPI 3.1 snapshot (import to Postman or regenerate from the API when endpoints change)
Long-form internal markdown (deep setup, deployment) lives in the repo’s top-level docs/ folder—not in Mintlify. Link out when something belongs in the open-source tree rather than the product docs site. Visual source of truth: product typography and color tokens for the public site follow .project/design/design-system.html in the Synapse monorepo (primary #d7025c, Fraunces + Rethink Sans + JetBrains Mono). Keep apps/docs/docs.json and apps/docs/style.css aligned with that file when branding changes.

​
Run locally

From the repository root (not only inside apps/docs/): 
# Node.js 18–24 required; Mintlify fails on Node 25+
bun dev:docs
The preview binds to http://localhost:3000 when that port is free. If the Nuxt dashboard is already running on 3000, Mintlify chooses the next available port (watch the terminal output). Use the same Node range as in apps/docs/README.md at the repo root (fnm use 20 / nvm use with root .nvmrc).

​
Validate before you push

bun run docs:validate
bun run docs:check-links
Optional CI-style bundle: 
bun run ci:local:docs
Fix broken anchors and missing pages until validate and link checks are clean.

​
Editing navigation

  1. Open apps/docs/docs.json.
  2. Add or reorder page IDs under navigation.tabs → groups → pages. IDs are paths without .mdx (for example developer/documentation-site).
  3. Add a matching path/file.mdx file if it is a new page.
  4. Use redirects only for URL moves; avoid redirecting a real page to an unrelated target.

​
MDX conventions

  • Frontmatter: title and description on every page.
  • Prefer Mintlify components where they help: <Card>, <CardGroup>, <Info>, <Warning>, <Tabs>, <Steps>.
  • Use root-absolute paths for internal links (/guides/integrate-api, /api-reference/receptors) so they work in preview and production.

​
OpenAPI

The API reference intro links to /openapi.json. When the REST surface changes materially, regenerate from the API (see apps/api scripts) and replace apps/docs/openapi.json, then re-run validate.

​
LLM-oriented exports

llms.txt is curated for tooling; Mintlify also emits a fuller corpus file. Treat them as generated—edit the underlying MDX and config, not the deployed llms-full output.