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.

​

Suki documentation style

​

When to use this skill

• Creating or editing any .mdx file in documentation/, api-reference/, web-sdk/, mobile-sdk/, headless-web-sdk/, dictation-sdk/, sdk-overview/, or updates/
• Reviewing or fixing capitalization, punctuation, or tone in docs
• User asks to “follow the style guide,” “fix style,” or “make it consistent with the docs”

​

Core rules to apply

1. Sentence case for headings and links: For headings (H2, H3), sidebarTitle, link text, table headers, list items. Not title case for these.
2. Product names unchanged: Web SDK, Mobile SDK, Headless Web SDK, Problem-Based Charting (PBC), Ambient Session, Partner ID, etc. Keep official capitalization.
3. Buttons and button-like UI use title case: Card titles, Step titles, Tab titles, Accordion titles, and CTA button text use title case to match product design (e.g. “Start Building,” “Create Session,” “Session Completion”).
4. No em dashes: Use commas, colons, or semicolons instead of —.
5. Oxford comma: Use in lists of three or more (e.g. “Android, iOS, and Windows”).
6. Tone: Professional, developer-focused, concise. Second person (“you”) for instructions; active voice; front-load key information.
7. Headless vs Dictation: Do not mix Headless Web SDK (headless-web-sdk/, @suki-sdk/platform-react, ambient hooks) with Dictation SDK (dictation-sdk/, DictationClient, iframe dictation) on the same procedural page. Product comparison belongs on hub pages (overview, learning path, integration decision guide) or a single steering paragraph on an intro, not in the other product’s quickstart or hook guides.
8. Headings: No period at the end. Prefer task-based (bare infinitive, e.g. “Create a session”) or noun phrases for conceptual sections.
9. SDK reference + ResponseField: Use a purposeful intro (“These are the settings you provide…”) not “The following options are available.” Keep each ResponseField direct and declarative; use required / Optional: like Authentication hook. For constructor or provider details not fully specified in-repo, anchor copy to on-site examples and links (Quickstart); see STYLE_GUIDE.md (SDK reference pages and ResponseField).

​

Quick checklist

• All headings and frontmatter titles in sentence case
• Link text in sentence case
• Table headers and labels in sentence case
• Card/Step/Tab/Accordion titles and button text in title case
• No em dashes; Oxford comma in lists
• Product names (Web SDK, PBC, etc.) left as-is
• SDK reference groups use a direct intro line; ResponseField bodies are declarative, not hedge-heavy
• Headless Web SDK and Dictation SDK content stay in their own sections or product pages (no mixed quickstarts)

​

References

• Full style guide: STYLE_GUIDE.md (voice, punctuation, capitalization, inclusivity, terminology, workflow)
• Structure and process: AGENTS.md (file structure, navigation, release note format)
• Mintlify components: .cursor/rules.mdx in the repo (callouts, Steps, Tabs, code blocks, API components; Cursor rule file, not a published docs URL)
• Use-case-first guides (hooks, classes, methods): guide-use-case-structure