Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.velt.dev/llms.txt

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

Docs Path → Skill Mapping

Status: Frozen ground truth for the skills-sync pipeline. Loaded by Agent 1 (docs-diff-planner) as an input.

Mapped paths

Docs path prefixTarget skill(s)
async-collaboration/comments/**velt-comments-best-practices
async-collaboration/notifications/**velt-notifications-best-practices
async-collaboration/recorder/**velt-recorder-best-practices
async-collaboration/activity/**velt-activity-best-practices
realtime-collaboration/presence/**velt-presence-best-practices
realtime-collaboration/cursors/**velt-cursors-best-practices
realtime-collaboration/huddle/**velt-huddle-best-practices
realtime-collaboration/crdt/**velt-crdt-best-practices, yjs-best-practices
realtime-collaboration/single-editor-mode/**velt-single-editor-mode-best-practices
get-started/**velt-setup-best-practices
security/auth-tokens.mdx, security/jwt-tokens.mdx, security/supported-regions.mdxvelt-setup-best-practices
security/proxy-server.mdx, security/content-security-policy.mdxvelt-proxy-server-best-practices
ai/rewriter/**velt-rewriter-best-practices
self-host-data/**velt-self-hosting-data-best-practices
backend-sdks/python.mdxvelt-self-hosting-data-best-practices
api-reference/rest-apis/v1/**, api-reference/rest-apis/v2/**velt-rest-apis-best-practices
webhooks/basic.mdx, webhooks/advanced.mdxroute by event family (see §webhook routing)
ui-customization/features/<feature>/**skill matching <feature> (e.g., commentsvelt-comments-best-practices)

Webhook routing

webhooks/basic.mdx and webhooks/advanced.mdx are cross-cutting. The planner examines diff hunks for event-name prefixes and routes:
Event prefixTarget skill
comment.*velt-comments-best-practices
notification.*velt-notifications-best-practices
recorder.*, recording.*velt-recorder-best-practices
activity.*velt-activity-best-practices
huddle.*velt-huddle-best-practices
presence.*velt-presence-best-practices
cursor.*velt-cursors-best-practices
crdt.*, yjs.*velt-crdt-best-practices
editor.*, single-editor-mode.*velt-single-editor-mode-best-practices
Anything elsevelt-rest-apis-best-practices (default webhook home)

Unmapped feature paths (file issue, do not edit skills)

These docs paths exist but have no skill counterpart. Agent 1 sends them to unmapped; Agent 4 files an issue with a suggested slug.
PathSuggested slugNotes
async-collaboration/arrows/**velt-arrows-best-practicesNew skill candidate
async-collaboration/comments-sidebar/**(extend existing)Likely folds into velt-comments-best-practices — file as extension proposal, not new skill
async-collaboration/reactions/**velt-reactions-best-practicesNew skill candidate
async-collaboration/view-analytics/**velt-view-analytics-best-practicesNew skill candidate
realtime-collaboration/flock-mode/**velt-flock-mode-best-practicesNew skill candidate
realtime-collaboration/live-selection/**velt-live-selection-best-practicesNew skill candidate
realtime-collaboration/live-state-sync/**velt-live-state-sync-best-practicesNew skill candidate
realtime-collaboration/video-player-sync/**velt-video-player-sync-best-practicesNew skill candidate
permission-management/**velt-permissions-best-practicesNew skill candidate
in-app-user-feedback/**velt-feedback-best-practicesNew skill candidate

Explicitly out-of-scope (drop silently)

The planner drops these without filing issues:
  • release-notes/** — handled by the existing release-note pipeline
  • key-concepts/**, migration/** — conceptual; no skill counterpart
  • integrations/** — third-party; not in skill scope today
  • mcp/**, ai/** — meta-docs (if they exist)
  • images/**, gifs/**, global-styles/**, snippets/**, *.css — assets and shared MDX fragments
  • live-co-editing/** — deprecated
  • api-reference/open-api/**, api-reference/postman-collection/** — tooling assets, not endpoint docs
  • api-reference/sdk/models/**, api-reference/sdk/api/** — out-of-scope by default; if a model rename touches multiple skills, surface as a cross-skill terminology change (manual review)

Updater variant dispatch (matched against the resolved skill name)

VariantSkills
frontend-async-skill-updatervelt-comments-best-practices, velt-notifications-best-practices, velt-activity-best-practices, velt-recorder-best-practices
frontend-realtime-skill-updatervelt-presence-best-practices, velt-cursors-best-practices, velt-huddle-best-practices, velt-single-editor-mode-best-practices, velt-crdt-best-practices
setup-skill-updatervelt-setup-best-practices
backend-skill-updatervelt-rest-apis-best-practices, velt-self-hosting-data-best-practices
infra-skill-updatervelt-proxy-server-best-practices, yjs-best-practices
ai-skill-updatervelt-rewriter-best-practices