Creating a Project

Create Your Project 🎨

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

Navigate Your Dashboard 🧭

Get comfortable with your command center:

  1. 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
  2. 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
  3. Project Settings

    • Customize project details anytime from the settings menu
    • Manage team access and permissions
    • Configure integration options for your workflow

Manage Your Profile 👤

Make ReadMe yours with a personalized profile:

  1. 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
  2. Account Preferences

    • Set your notification preferences
    • Configure 2FA for enhanced security
    • Manage your API keys for ReadMe access
  3. Team Collaboration

    • Invite team members to contribute
    • Assign appropriate roles and permissions
    • Create a collaborative documentation workflow

Search and Organize Your Projects 🔍

Keeping everything at your fingertips:

  1. 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
  2. Project Organization

    • Arrange projects by priority or category
    • Use tags to group related projects
    • Archive completed or inactive projects
  3. 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