Creating a Project

Create Your Project 🎨

Let's give your API documentation a home. Follow these quick steps:

1. Sign into your ReadMe account
2. Click Create New Project
3. Name your project to match your API
4. Upload your logo (we'll match your brand colors automatically!)
5. Choose your subdomain (e.g., yourcompany.readme.io)

☝️

Migrating from another platform? Check our migration guide for a smooth transition.

Navigate Your Dashboard 🧭

Your dashboard is mission control for all documentation tasks. Here's what you need to know:

For Beginners

1. Dashboard Overview

   • View all your projects in one place
   • Check recent activity and basic metrics
   • Access everything from this central hub

2. Basic Navigation

   • Use the left sidebar for quick section access
   • Switch between edit and view modes easily
   • Find project settings in the top menu

For Intermediate Users

3. Project Configuration
   • Customize project details in the settings menu
   • Set up team access and permissions
   • Configure integrations for your workflow

Manage Your Profile 👤

Personalize your ReadMe experience with these profile settings:

1. Profile Setup

   • Click your avatar (top-right corner)
   • Update your name and profile picture
   • Add your role and contact details

2. Security & Preferences

   • Enable two-factor authentication (2FA)
   • Set notification preferences
   • Generate API keys for programmatic access

3. Team Features

   • Invite team members to collaborate
   • Assign roles based on responsibilities
   • Build an efficient documentation workflow

Search and Organize Projects 🔍

Keep your projects organized and accessible:

1. Search Features

   • Use the top search bar for quick project lookup
   • Filter by name, status, or team
   • Save time with smart search suggestions

2. Organization Tips

   • Beginners: Start with simple naming conventions
   • Advanced: Use tags for complex categorization
   • Archive inactive projects to reduce clutter

3. Quick Navigation

   • Access the project dropdown for fast switching
   • View status indicators for each project
   • Use the history menu for recent projects