How we migrated our SDK docs to DocC at RevenueCat

In early 2022, RevenueCat transitioned its iOS documentation from Jazzy to Apple's DocC, motivated by DocC's potential for enhanced organization, readability, and integration with Xcode. DocC offers a structured format that allows documentation to be organized into logical sections, improving navigation for users, and features like Dark Mode and seamless Xcode integration further enhance the user experience. A key advantage of DocC is its ability to generate warnings for outdated symbols, ensuring documentation accuracy, which was a significant factor in RevenueCat's decision to switch. The migration process was facilitated by the compatibility of Jazzy's format with DocC, allowing for a smooth transition without interrupting ongoing development. Additionally, RevenueCat set up their documentation to be hosted on GitHub Pages with continuous integration, although challenges remain, such as the lack of built-in versioning support in DocC. Despite these challenges, the company is pleased with the improvements and looks forward to incorporating features like interactive tutorials and a language selector in the future.

No tracked trend matches for this post yet.

Use this post, company, and trend context to find content marketing opportunities, perform competitive analysis, or address product feature gaps via the Plushcap MCP server or the Plushcap API.