# Quickstart

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

<Cards>
  <Card title="1: Create Your Docs" href="#step-1-create-your-project-" icon="fa-palette">
    Sign into ReadMe, create a new project, name it, and upload your logo.
  </Card>

  <Card title="2: Add API Spec" href="#step-2-add-your-openapi-specification-" icon="fa-file">
    Upload your OpenAPI spec (file or URL) to auto-generate interactive API docs with a live preview.
  </Card>

  <Card title="3: Build with AI" href="#step-3-create-your-first-guide-" icon="fa-sparkles">
    Create guides by adding a "Getting Started" category and writing pages in Markdown.
  </Card>
</Cards>

## Step 1: Create Your Project 🎨

First things first – give your API documentation a home:

1. Sign into your ReadMe account
2. Click "Create New Project"
3. Give your project a name that resonates with your API
4. 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:

<Tabs>
  <Tab title="Upload File Directly">
    **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
```

  </Tab>

  <Tab title="Import via URL">
    **Import via URL**

```
* Pop your OpenAPI specification URL into the field
* Click **Import OpenAPI file**
* We fetch and validate your spec automatically
```

  </Tab>
</Tabs>

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.

<Callout icon="👀" theme="default">
  ### Best Practice

Keep an eye on that preview – it's your first look at how developers interact with your API docs! 🎯 </Callout>

## 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:

1. Click the **Edit** button in the top navigation (look for that friendly pencil icon!)
2. Click "+ NEW CATEGORY" to create a home for your getting started guides
3. Name your category "Getting Started" – this is your developers' first stop
4. See that "+" button next to your new Getting Started category? Click it to create your first guide page
5. 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:

<Cards columns={2}>
  <Card title="Customize Your Hub" href="https://docs.readme.com/main/docs/design-themes" icon="fa-paint-brush">
    Add your brand colors and custom domain to make your documentation truly yours.
  </Card>

  <Card title="Monitor API Usage" href="https://docs.readme.com/main/docs/developer-dashboard" icon="fa-chart-line">
    Keep tabs on how developers use your API with built-in analytics.
  </Card>

  <Card title="Build Your Community" href="https://docs.readme.com/main/docs/community-building" icon="fa-users">
    Enable discussions and suggested edits to foster collaboration with your developer community.
  </Card>

  <Card title="Stay Current" href="https://docs.readme.com/main/docs/changelog" icon="fa-newspaper">
    Keep your changelog updated with the latest API changes and improvements.
  </Card>
</Cards>

***

<Accordion title="Pro Tips for Great Documentation" icon="fa-lightbulb">
  * **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
</Accordion>

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!

<br />