Creating a Project

Create Your Project 🎨

First things first – let's 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'll work our magic to match your brand colors!)
Choose a subdomain that makes sense for your brand (e.g., yourcompany.readme.io)

Get comfortable with your command center:

Project Dashboard Overview
- The dashboard is your mission control for all things documentation
- Access all your projects from this central hub
- View project metrics and recent activity at a glance
Quick Navigation
- Use the left sidebar to jump between key sections
- Access project settings, appearance options, and more
- Switch between edit and view modes with a single click
Project Settings
- Customize project details anytime from the settings menu
- Manage team access and permissions
- Configure integration options for your workflow

Make ReadMe yours with a personalized profile:

Setting Up Your Profile
- Click your avatar in the top-right corner
- Update your display name and profile picture
- Add your role and contact information
Account Preferences
- Set your notification preferences
- Configure 2FA for enhanced security
- Manage your API keys for ReadMe access
Team Collaboration
- Invite team members to contribute
- Assign appropriate roles and permissions
- Create a collaborative documentation workflow

Keeping everything at your fingertips:

Project Search
- Use the search bar at the top of the dashboard
- Filter projects by name, status, or team
- Find exactly what you need, when you need it
Project Organization
- Arrange projects by priority or category
- Use tags to group related projects
- Archive completed or inactive projects
Quick Project Switching
- Toggle between projects from the dropdown menu
- See project status indicators at a glance
- Access recent projects faster with the history menu