​

Agent Guidelines for Suki API Documentation

​

Project Type

This is a Mintlify documentation site for Suki’s healthcare AI platform APIs and SDKs.

​

Build/Development Commands

• mintlify dev - Start local development server
• mintlify install - Reinstall dependencies if dev server fails
• No test commands (documentation site)

​

File Structure

• docs.json - Main Mintlify configuration file
• api-reference/ - API documentation pages
• web-sdk/ - Web SDK documentation
• mobile-sdk/ - Mobile SDK documentation
• documentation/ - General platform documentation

​

Content Guidelines

• Use MDX format for all documentation files
• Include frontmatter with title and description
• Use consistent image patterns: light/dark mode variants with className="block dark:hidden" and className="hidden dark:block"
• Follow healthcare/medical terminology standards
• Maintain professional, clinical tone appropriate for healthcare developers

​

Navigation Structure

• Organized by tabs: Documentation, API, Mobile SDK, Web SDK
• Each tab has groups with nested pages
• Update docs.json navigation when adding new pages
• Maintain consistent grouping patterns (Documentation, Guides, API Reference, Examples, FAQs)

​

Web SDK

• Use the existing code block Structure with js and react tabs and codeblocks with appropriate icons
• Ensure code examples are clear and relevant to the SDK usage
• Add references, read more options with the link to some other section of the documentation if necessary.