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:

Types of Documentation in ReadMe

Guides: Step-by-step tutorials and comprehensive explanations that teach developers how to use your API
API Reference: Interactive documentation generated from your OpenAPI specification
Recipes: Code walkthroughs that show developers how to accomplish specific tasks
Changelog: Updates about new features and changes to your API
Custom Pages: Special content like landing pages or FAQs that don't fit into other categories

👉 Learn more about our doc types

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:

Plan your documentation strategy: Decide what types of content you need and how to organize it
Set up your API reference: Import your OpenAPI specification to create interactive API docs
Create your first guide: Write a "Getting Started" guide that helps developers make their first API call
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!