RevenueCat Documentation Site

This repository contains the documentation website for RevenueCat, a platform that helps mobile app developers manage subscriptions and in-app purchases. The site is built with Docusaurus, a tool that turns Markdown files into a polished, searchable website with automatic dark mode, mobile responsiveness, and built-in navigation.

Think of this repository as the source code for the instruction manual that RevenueCat users read to learn how to integrate the service into their apps. When someone visits docs.revenuecat.com, they're viewing the published version of what lives here. Anyone can contribute—whether you're fixing a typo, clarifying confusing instructions, or adding new guides—by editing Markdown files and submitting a pull request.

The workflow is straightforward. You write or edit documentation in simple Markdown format (similar to how you'd format a README on GitHub), save it to the /docs folder, and push your changes. The site automatically rebuilds and deploys to a preview environment so you can test it. Once merged to the main branch, it goes live instantly. For non-technical users who aren't comfortable with GitHub, RevenueCat offers an alternative: you can contact support or open an issue requesting the change, and the team will handle it.

The repository is organized with sidebar navigation defined in a configuration file called sidebars.ts. This file determines what appears in the left menu, how sections are grouped, and what icons are used. Documentation can include code snippets in multiple programming languages (using a custom component that displays them in tabs), YouTube videos, images, and links to related pages. The README emphasizes consistent organization—grouping related content logically, using descriptive headings, and including practical examples—so users can find answers quickly.

For developers contributing to the docs, the setup is minimal: install Node.js and Yarn, run yarn install to grab dependencies, and yarn start to see changes live as you type. The project also supports optional spell-checking via a typos checker tool. Whether you're a RevenueCat team member maintaining official docs or a community member suggesting improvements, this repository is designed to make documentation updates as frictionless as possible.