Introduction

Welcome to your documentation command center! At ReadMe, we believe great API documentation should be as dynamic as your code. Whether you're documenting your first endpoint or managing docs across multiple versions, we've got everything you need to create documentation that your developers will actually love to use.

🌟 Why Documentation Matters

Great documentation is the difference between developers embracing your API or abandoning it. When your docs are clear, interactive, and well-organized, you're not just documenting your API—you're creating an experience that makes developers successful. And successful developers become your most loyal advocates.

🧭 Understanding Your Documentation Hub

Your ReadMe hub is where developers go to learn how to use your product. Let's break down the key components that make up your documentation ecosystem:

The Documentation Toolkit You Actually Want to Use

ReadMe's core documentation types are designed to create a complete, engaging developer experience that covers all the bases, from "What does this API do?" to "Show me exactly how to implement this specific use case." Each documentation type serves a distinct purpose in your strategy, and together they create a comprehensive resource that helps developers go from curious visitors to power users.

📘 Guides: Your API's Instruction Manual

Guides are the bread and butter of your documentation—the friendly, conversational pages that walk developers through concepts, provide context, and explain the "why" behind your API. They're perfect for getting started tutorials, authentication explanations, best practices, and in-depth explanations of complex workflows. Guides shine when you need to explain concepts in a logical sequence or provide the bigger picture.

Create Your First Guide →

🔌 API Reference: Your API's Source of Truth

Your API reference is the definitive, interactive catalog of all your endpoints, parameters, and response schemas. Generated from your OpenAPI specification (or created manually), it's where developers go when they need specific technical details. What makes ReadMe's API reference special is its interactivity—developers can make actual API calls right from your docs, with their own API keys automatically populated.

Set Up Your API Reference →

🧩 Recipes: Your API's Cookbook

While guides explain concepts and the API reference details endpoints, recipes show developers exactly how to accomplish specific tasks using your API. They're step-by-step walkthroughs of common use cases, complete with code examples in multiple programming languages. Recipes bridge the gap between understanding your API and actually using it.

Create Your First Recipe →

📰 Changelog: Your API's News Feed

Your API is constantly evolving, and developers need to know what's changed. The changelog is your dedicated space for announcing new features, breaking changes, deprecations, and bug fixes. A well-maintained changelog keeps developers informed and shows that your API is actively maintained and improved.

Start Your Changelog →

📄 Custom Pages: Your API's Specialty Content

Some content doesn't neatly fit into guides, reference, recipes, or changelogs. Custom pages are flexible spaces for content like standout landing pages, FAQ collections, status pages, or special announcements that deserve special treatment.

Create a Custom Page →

Hub Structure and Navigation

Your ReadMe hub is designed to help developers find what they need quickly. The main navigation includes:

• Left sidebar: Categories and pages organized in a logical hierarchy
• Top navigation: Version switcher, search, and main section tabs
• Edit/View toggle: Switch between viewing your docs and editing them directly on the hub

✨ Write Documentation That Developers Love

Create documentation that speaks to your developers with our powerful suite of documentation tools:

🎯 An Editor That Works Where You Do

Our editing experience brings documentation creation right to your hub. Make changes on the fly, preview in real-time, and publish with confidence – all from one seamless interface. With our MDX-powered editor, you can transform conventional documentation into an interactive experience by adding dynamic components and custom behaviors.

🔌 API Reference That Shows and Tells

Turn your OpenAPI specification into beautiful, interactive API documentation. Developers can make live API calls right from your docs, see their API keys automatically populated, and explore endpoints with our built-in API playground. Whether you're working with OpenAPI 3.0, 3.1, or Swagger 2, we'll help you create reference documentation that gets your API into the hands of developers faster.

🌱 Documentation That Grows With You

As your API evolves, your documentation needs to keep pace. ReadMe provides the tools you need to scale your documentation:

• Versioning: Maintain documentation for multiple API versions
• Bi-directional Git sync: Write documentation in GitHub or GitLab and automatically sync it to ReadMe (and vice versa)
• MDX components: Create reusable content components that can be updated once and reflected everywhere

🚀 Next Steps: Your Documentation Journey

Ready to build documentation your developers will love? Here's how to get started:

1. Plan your documentation strategy: Decide what types of content you need and how to organize it
2. Set up your API reference: Import your OpenAPI specification to create interactive API docs
3. Create your first guide: Write a "Getting Started" guide that helps developers make their first API call
4. Explore advanced features: Try MDX components, reusable content, and bi-directional sync

Click on any of the topics in the sidebar to dive deeper into these areas and start building documentation that helps your developers succeed.

🛠️ Documentation Quick Start Checklist

• Import your OpenAPI specification
• Create a "Getting Started" guide
• Add your API authentication details
• Add your team members as contributors
• Connect your GitHub repository for bi-directional sync

Ready to make your documentation shine? Let's dive in!