​

Repository Guidelines

​

Project Structure & Module Organization

• Root .mdx files (e.g., overview.mdx, quickstart.mdx) power the top-level navigation defined in docs.json.
• Topical directories such as api-reference/endpoint, integrations/, sdk/, and search/ hold focused guides; keep related assets in images/ or logo/.
• Shared API contracts live in api-reference/openapi.json; update this before revising endpoint docs.

​

Build, Test, and Development Commands

• npm i -g mintlify installs the Mintlify CLI required for local preview.
• mintlify dev (run from the repository root) launches the hot-reloading docs server.
• mintlify build validates the content and produces the static site bundle that matches production.
• mintlify install repairs CLI dependencies if the dev server fails to start.

​

Coding Style & Naming Conventions

• Author pages in MDX with frontmatter containing title and description; place the metadata between triple-dashed lines.
• Use sentence case headings starting at ##; reserve # for the page title handled by frontmatter.
• Prefer kebab-case filenames and directory names that mirror sidebar labels.
• Leverage Mintlify components (<Note>, <Card>, <CodeGroup>) and keep JSX props indented two spaces for readability.

​

Testing Guidelines

• Preview all edits with mintlify dev and scan for console warnings, broken components, and layout regressions.
• Manually click through new or changed sidebar entries to ensure anchors render and links resolve.
• Run mintlify build before submitting substantial changes to catch syntax or MDX compilation errors.
• There is no automated coverage requirement; rely on peer review and screenshots for complex UI updates.

​

Commit & Pull Request Guidelines

• Follow the existing convention of [TYPE] Short description (e.g., [FEAT] Add DeepSearch example); use [CHORE], [FIX], and [DOCS] as needed.
• Keep commits scoped to a single thematic change and include relevant documentation assets.
• Pull requests should describe the change, reference any tracked issue, list verification steps (mintlify dev, mintlify build), and attach screenshots or GIFs when visual output changes.

​

Configuration & Access Tips

• Update theme, navigation groups, and footer links in docs.json; propose structured diffs when altering shared config.
• Never commit real API keys; use placeholders in samples and sanitize environment variables before sharing logs.
• Store newly created images under images/ with descriptive filenames, and compress assets to keep the docs lightweight.