This changelog covers documentation site updates, content improvements, and user experience enhancements. For API and SDK changes, see their respective changelogs in the API, Web SDK, and Mobile SDK sections.
Documentation Site Changes
- Brand new landing page inspired by top AI documentation sites, designed for clarity and impact and Suki’s latest brand guidelines
- Improved navigation and information architecture for smoother discovery and usability
- SDK Navigation changes: With the new navigation structure, you can now navigate to the SDKs section and its subpages using the dropdowns from the SDKs tab
- Updated graphics following Suki’s latest brand guidelines
- Enhanced AI Assistant and search with refined keyword optimization
New Content
- New Telehealth guide added in the Web SDK section to support telehealth integrations
- MCP Integration Guide: New guide to help developers integrate the Suki Developer Documentation as an MCP service into their AI code editor
Improvements
- Completely rewritten Web SDK section for improved readability and developer experience
- Types reference page: Completely rewritten the types reference page(web SDK only) for improved readability and developer experience
- Added Code Examples: Added code examples for all of the SDP APIs
- Added proper property descriptions: Added proper property descriptions using
ResponseFieldcomponent in the necessary places for the API, Mobile SDK, and Web SDK reference documentation - Bug fixes
Documentation Site Changes
- New Quickstart Guide: Comprehensive getting-started page with step-by-step integration workflows
- Improved UI/UX: Better visual hierarchy, consistent styling, and mobile-responsive design
- Better Search: Enhanced content organization and searchability across all documentation
- Integration Decision Guide: New guide to help developers choose between API, Web SDK, and Mobile SDK
- API Reference Tags: Added visual indicators for new, updated, deprecated, and early access features
- Reorganized Mobile SDK pages: Reorganized and created new mobile SDK pages for better organization
New Content
- Ambient Documentation Guide: Comprehensive guide explaining how ambient documentation works
- Integration Decision Guide: New guide to help developers choose between API, Web SDK, and Mobile SDK
- API Documentaation Guidelines: New page to help developers understand our API status tags like new, updated, deprecated, and early access
Improvements
- Reorganized Tabs: Renamed “Documentation” to “Introduction” for better clarity
- New Guides Section: Separated platform guides into dedicated tab for better organization
- Improved Cross-linking: Better internal linking between related documentation sections
- Mobile Experience: Enhanced mobile navigation and reading experience
- Glossary: Improved the organization of the glossary page by adding alphabetical navigation links. This allows users to quickly jump to terms starting with a specific letter
Improvements
- Glossary: Added a new glossary page to help you understand the terminology used in the documentation.
- New Overview Page: Created a new overview page for platfrom documentation to help you understand the platform and its capabilities.
- OpenAPI Updates: Enhanced many API specifications with better examples and descriptions for most of the endpoints.
- Response Examples: Corrected and added comprehensive response examples for most of the endpoints.
- Rewritten Guides and Existing Pages: Rewritten and improved many guides and existing pages to make them more readable and informative as per Suki’s documentation standards
Documentation Site Foundation
- Initial Launch: First version of the Suki Developer Documentation site
- Core Content: Basic API reference, SDK guides, and getting started documentation
- Search Integration: Implemented full-text search across all documentation
- Brand Integration: Applied Suki branding(v1) and design system
How To Stay Updated
Banner Notifications
Important updates are announced via site-wide banners at the top of every page
Changelog Subscription
Bookmark this page and check back regularly for the latest documentation updates
Have suggestions?We’re always looking to improve our documentation. Contact our team with feedback, requests for new content, or suggestions for better organization.