Quickstart

Ready to create stellar, interactive API documentation? Get your developer hub up and running in minutes!

Step 1: Create Your Project

First things first – give your API documentation a home:

Sign into your ReadMe account
Click "Create New Project"
Give your project a name that resonates with your API
Upload your logo (we work our magic to match your brand colors!)

Step 2: Add Your OpenAPI Spec

Transform your OpenAPI spec into engaging, interactive documentation.

Upload your file directly or import via URL – we'll validate and process it automatically.

Once uploaded, you'll see a preview of your API endpoints and documentation structure!

Step 3: Create Your First Guide

Make your docs shine by creating helpful guides:

Click the Edit button
Create a "Getting Started" category
Add your first guide page
Write with Markdown and custom components

Step 1: Create Your Project 🎨

First things first – give your API documentation a home:

Sign into your ReadMe account
Click "Create New Project"
Give your project a name that resonates with your API
Upload your logo (we work our magic to match your brand colors!)

Step 2: Add Your OpenAPI Specification 📚

Here's where the real magic happens! We transform your OpenAPI spec into engaging, interactive documentation. You have two great options:

Upload Your File Directly

Hit that big blue "Upload OpenAPI file" button
Select your OpenAPI/Swagger specification file
Watch as we validate and process your spec

Once your spec is uploaded, we give you a sneak peek of your new docs! You see:

A preview of your API endpoints
Your documentation structure
A success message confirming everything looks great
The Go to Docs button that unveils your transformed API reference

Don't have an OpenAPI file handy? No worries! You can click Skip to Docs and explore more API documentation options in your project settings later.

👀
Best Practice
Keep an eye on that preview – it's your first look at how developers interact with your API docs! 🎯

Step 3: Create Your First Guide 📝

Time to make your docs shine! You're greeted with a Getting Started page in View mode – transform it into something awesome:

Click the Edit button in the top navigation (look for that friendly pencil icon!)
Click "+ NEW CATEGORY" to create a home for your getting started guides
Name your category "Getting Started" – this is your developers' first stop
See that "+" button next to your new Getting Started category? Click it to create your first guide page
Time to write! Hit the '/' key while writing to summon our handy menu of content blocks and components:
- Craft your documentation with Markdown
- Drop in code blocks that developers can copy to try out
- Spice things up with custom components

Remember: Great documentation tells a story. Start with the basics and guide your developers through their journey with your API. What do they need to know first? What quick wins can you help them achieve? 🎯

What's Next? 🎯

You've got the foundations – now make your docs truly shine:

Customize Your Hub

Add your brand colors and custom domain to make your documentation truly yours.

Monitor API Usage

Keep tabs on how developers use your API with built-in analytics.

Build Your Community

Enable discussions and suggested edits to foster collaboration with your developer community.

Stay Current

Keep your changelog updated with the latest API changes and improvements.

Pro Tips for Great Documentation

Start simple: Focus on the most common use cases first
Use examples: Real code samples help developers get started faster
Test your docs: Try following your own guides as if you're a new user
Iterate often: Documentation is never "done" – keep improving based on feedback

Need a hand? Our friendly support team is just a chat away – look for the owl in the corner! 🦉

Remember, great documentation is a journey, not a destination. We're here to help you make yours exceptional!