Documentation Index
Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
Use this file to discover all available pages before exploring further.
CLAUDE.md — Mintlify Documentation
Content Accuracy
- Never invent steps, options, field names, descriptions, or any other content. Only document what is confirmed from code, the OpenAPI spec, or screenshots provided by the user.
- When anything is not 100% clear and defined — a page’s content, a feature’s behaviour, a field name, a UI flow — stop and ask the user before writing anything. This applies to stub pages, descriptions, frontmatter, and prose alike.
- Never state a count of supported models or entities without reading it from the actual data source. If unsure, omit the count and link to the relevant page instead.
- Do not add “Coming Soon” sections unless explicitly instructed.
Writing Style
- NEVER use em dashes (—) in any content you write or edit. This includes alt text, captions, prose, and descriptions. Do not fix em dashes found in pre-existing prose you did not write.
- After writing or editing alt text or captions, grep those specific strings for
—before moving on. If any match is found in content you wrote, fix it. - Never use hyphens as separators between a term and its description (e.g.
**Term** - description). Use a colon instead:**Term**: description. - Bold all product name mentions inline (e.g. Orq.ai, AI Router, AI Chat).
- Capitalize orq.ai product entity names in prose and links: Evaluators, Identities, Deployments, Agents, Prompts, Threads, etc.
- Page titles follow the pattern:
"Product | Page Name"(e.g."AI Router | Credits"). - Use Mintlify
<Icon />components instead of describing icons in prose (e.g.<Icon icon="ellipsis" />instead of “click the three dots”). - No warnings or disclaimers about AI making mistakes.
- No self-referential comments in any output.
- Never use “you” or “your” in prose. Use imperative voice instead (e.g. “Set the desired filters” not “Set your desired filters”; “Create custom traces” not “You can create custom traces”).
Alt Text
- Every image must have alt text that describes what the image actually shows, not the page title, section heading, or release label (e.g. “Past Updates”, “Release 3.12”).
- Alt text must be specific to the individual image. When multiple images appear on the same page or in the same section, each must have a distinct alt that reflects its unique content.
- Never copy-paste alt text from an adjacent image. Verify each image’s alt describes only that image.
- Derive alt text from: the surrounding prose, the Frame caption, and the image filename. If none of these give enough context, stop and ask.
- For GIFs and animations, describe the action shown, not a static state.
- For changelog images: describe the specific feature or UI being shown, not the release name.
- After adding or editing images, grep the file for repeated alt strings to catch copy-paste errors before moving on.
- No em dashes in alt text or captions you write.
Mintlify Components
- Never place headings (
##,###,####) inside<Tab>components. Mintlify renders the TOC from headings in the active tab only, so the TOC changes as the user switches tabs. All headings must live outside<Tabs>/<Tab>wrappers. Tab content should use bold text or prose structure instead of headings.
Communication
- Be as brief as possible. High signal-to-noise ratio. No complete sentences needed, no filler, no summaries of what was just done.
Enterprise Features
- Every page documenting an Enterprise-only feature must include this badge at the top of the content (after the frontmatter), right-aligned:
- Do not use a
<Note>or any other component for this — the badge is the only approved pattern.
Collaboration
- Do not agree with suggestions just because they are made. Verify claims independently before accepting them. If something is debatable or unverified, say so clearly and push back with evidence or honest uncertainty.
- Never present opinions as facts.