Documentation Index

Fetch the complete documentation index at: https://developer.suki.ai/llms.txt

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

​

Agent guidelines: Suki developer documentation

How to work in this repo: scope, style, layout, navigation, and release notes. Prefer this file over guessing when behavior is not obvious from the tree alone.

---

​

What this repo is

Mintlify documentation for Suki’s healthcare AI platform: APIs, SDKs, guides, glossary, and release notes. Main config is docs.json; most content is MDX under the directories below.

---

​

Agent workflow

Todos: For documentation work, create a todo list (review content, check links, verify examples, update dates) and work through it. Style: Follow STYLE_GUIDE.md: sentence-style headings, Oxford comma, no em dashes (use commas or colons), professional developer tone.

---

​

Scope (do not assume)

• Do only what the user asked. If they want verification or investigation, report findings from the repo (gaps, contradictions). Do not rewrite many pages or assert product behavior unless they asked for doc updates or confirmed facts.
• If ground truth is missing (for example whether something exists in a shipped SDK), ask the user instead of inventing it.
• Large or cross-cutting edits need an explicit request or a short plan the user approves.

---

​

Git: commit and push

• Do not run git commit or git push unless the user explicitly asks (for example “commit”, “push”, “commit and push”).
• If they did not ask, leave the working tree as-is, summarize changes, and let them commit when ready.

---

​

Local development and QA

E2E tests: Live in the separate repo LearningMotors/documentation-testing, run against mint dev or PLAYWRIGHT_BASE_URL staging. This repo has no Playwright scripts. Browser check: After you change custom layout, carousels, tabs, or client scripts that affect #content-area, verify in a real browser (for example Cursor browser MCP against mint dev and the page path). Mintlify’s article column is often much narrower than full-window width; do not assume layout from window.innerWidth alone.

---

​

Repository layout

​

Core directories

Details for scripts and PDF behavior: scripts/README.md.

​

Headless Web SDK vs Dictation SDK (hard boundary)

Treat them as separate products.

• headless-web-sdk/ — @suki-sdk/platform-react, ambient hooks, related API reference. Hook guides: headless-web-sdk/guides/hooks/ (auth-hook, ambient-hook, ambient-session-hook). Other guides stay under guides/. In docs.json, Guides include a Hooks subgroup; API Reference lists platform-client first, then nested Types. Do not put Dictation SDK packages, DictationClient, or iframe dictation here.
• dictation-sdk/ — @suki-sdk/core, @suki-sdk/dictation / dictation-react, SukiAuthManager, DictationClient, hosted iframe. In SDKs, menu entries Dictation SDK (React) and Dictation SDK (JavaScript) use paths dictation-sdk/tracks/react and dictation-sdk/tracks/javascript, then shared pages and dictation-sdk/guides/. Spec: dictation-sdk/Suki Dictation SDK.md. Do not blend Headless quickstarts or PlatformClient flows in here except a short pointer to Headless/Web where comparison belongs.

Allowed overlap: Hub or decision pages only (documentation/overview, integration-decision-guide, sdk-overview/overview, learning-path), each product in its own section or tab; dictation-sdk/introduction may contrast with Web or Headless in one steering paragraph. Beta chip: scripts/wide-content.js adds the yellow Beta on Headless Web SDK Overview and Dictation SDK Overview (path prefixes headless-web-sdk/ and dictation-sdk/). PDF title row: dictation-sdk/introduction is in export-pdf.js EXCLUDED_EXACT so the Beta badge stays inline with the title.

​

Site scripts (high level)

scripts/announcement-banner.js

• Optional fixed bar (first body child); adjusts #navbar and CSS variables for sidebar and Mintlify Assistant. Toggle via CONFIG at top of file or remove the script entry from docs.json → scripts. See scripts/README.md (Site announcement banner).

scripts/export-pdf.js

• PDF control next to page h1; edit EXCLUDED_PREFIXES / EXCLUDED_EXACT to hide it where needed.
• Print path injects /logo/dark-light.svg into #content-area during print; @media print is theme-agnostic (light on paper).
• Opens <details> / tab panels for print; primeMermaidForPrint() before print; transform: none is not applied inside svg (Mermaid).
• PDF disabled on OpenAPI endpoint sections: api-reference/authentication, ambient-sessions, audio-transcription, ambient-content, user-preferences, feedback, asynchronous, info; also doc home/overview/introduction, SDK overview, updates/release-notes, updates/announcements, updates/release-notes-rss-feed (exact paths live in the script).
• PDF enabled on monthly updates/mmmYYYY-release-notes; release-notes-print.css and scripts/release-notes-print-scope.js add html.suki-print-monthly-release-notes styling.
• Avoid extra text-decoration: underline on links in print (Mintlify .link already uses a bottom border).

---

​

MDX and content conventions

• All docs in MDX with frontmatter title and description.
• Mermaid: New diagrams use ```mermaid actions={false} on the same line so Mintlify does not add zoom/pan chrome that breaks PDF/print. Use actions={true} only when you accept print tradeoffs, or use a static image for PDF.
• Images: Light/dark pairs with className="block dark:hidden" and className="hidden dark:block" when needed.
• Tone: Healthcare-appropriate, professional, clinical where it matters.
• Writing style: Same as STYLE_GUIDE.md (no em dashes, sentence case headings, Oxford comma).

---

​

Navigation (docs.json)

Tabs: Home, Docs, SDKs, APIs, Glossary, Release Notes (navigation.tabs). Docs tab: Getting Started, Guides (partner onboarding and partner authentication as direct pages, then 02. Core Workflows with Ambient (Clinical Notes) and Form Filling, 03. Charts & Orders, 04. Dictation, 05. Media & Integration with Overview, Streaming (ambient and dictation audio guides), audio download, webhook), Resources, Help & Support. SDKs tab: Mintlify menu on the tab (Menus): SDK overview, Web SDK, Mobile SDK, Headless Web SDK, Dictation SDK, each with groups / pages. scripts/sdk-tab-menu-beta-badges.js adds Beta next to Headless and Dictation in the dropdown (style.css). APIs tab: Same menu pattern. Suki APIs Guides groups: Get Started, Guides, Resources (nested Changelogs + FAQs), then Ambient API References and Form Filling API References. scripts/api-tab-menu-new-badge.js adds New next to Form Filling API References (.api-menu-new-badge in style.css). Tab-level directory: accordion where groups use root pages. New pages: Update docs.json; use flat paths (for example documentation/my-page, web-sdk/guides/ambient).

---

​

Web SDK

• Reuse existing CodeGroup patterns (js / react tabs, icons).
• Examples should be clear and tied to real SDK usage; add “read more” links where they help.

---

​

Release notes

​

Hub (updates/release-notes.mdx)

• Only the newest release card uses the LATEST badge; remove it from the previous card when you add a new one.

​

Changelog pills

The six Latest v… pills above the changelog cards sync from each product changelog.mdx via scripts/sync-release-notes-changelog-versions.mjs (lint-staged when updates/release-notes.mdx or any changelog.mdx is staged, or run npm run sync:release-notes-versions). Keep data-sync-changelog-latest="…" on each pill wrapper. See scripts/README.md.

​

RSS combined feed

• The release notes hub uses mode: frame; Mintlify does not put frame page updates into RSS.
• Combined feed: updates/release-notes-rss-feed.mdx (rss: true, hidden: true, no frame). URL: /updates/release-notes-rss-feed/rss.xml. Hub RSS button points at that XML.
• Subscribe modal: iframe from docs.json → variables → releaseNotesSubscribeEmbedUrl on updates/release-notes.mdx (data-embed-src). scripts/release-notes-subscribe.js: https: only, sets iframe src on open, capture-phase clicks (not native <dialog>). Source path /updates/release-notes-rss-feed stays for editors, hidden from sidebar.
• When you add a month to the hub timeline, add a matching <Update> in release-notes-rss-feed.mdx (newest first). See scripts/release-notes-rss.md.

​

Monthly release note pages

Path: updates/{month}{year}-release-notes.mdx (for example mar2026-release-notes.mdx). Structure

1. Frontmatter: title, description, sidebarTitle, rss: true
2. One short lead paragraph (no heading)
3. Sections: ## What's New, ## What's Enhanced, ## What's Changed, ## What's Removed as needed
4. <span id="kebab-case-anchor" /> before each <Update> for deep links
5. Each change in <Update label="..." description="..." tags={[...]}>. tag="LATEST" only on the single newest update.

Inside each <Update>

• Section heading: ### New Features | ### Enhancements | ### Deprecated | ### Removed (match the parent section)
• Badge: <Badge size="sm" color="...">…</Badge> — API blue, Web SDK green, Headless Web SDK orange , Dictation SDK purple, Form Filling API yellow
• Bold one-line title, body paragraphs, Why it matters: line, link relative from updates/

Style: STYLE_GUIDE.md; no em dashes; link to the right doc or API reference. s