Overview

The ReadMe Editing UI puts powerful documentation tools right at your fingertips, allowing you to create, edit, and manage content directly on your docs site. Whether you're writing new documentation or updating existing content, the Editing UI provides everything you need in one unified interface.

Getting Started

Accessing the Interface

When you log in to your ReadMe account, you'll land directly in the Editng UI. This gives you immediate access to all documentation management tools while viewing your docs exactly as your users see them.

Understanding the Interface

The Editing UI consists of two main areas that make documentation management intuitive:

Left Sidebar

• Navigate between different sections of your documentation
• Create and organize categories
• Manage page hierarchy

Top Navigation Bar

• Toggle between Edit and View modes
• Switch between documentation versions
• Access essential tools and settings:
  • Content Settings
  • Appearance Settings
  • Project Menu

What You Can Do

The Editing UI enables you to:

1. Create and Edit Content

   • Write documentation directly on your docs site
   • Format content using Markdown
   • Add interactive elements using slash commands

2. Manage Documentation

   • Customize appearance settings
   • Handle version control
   • Organize content structure

3. Maintain Content

   • Create reusable content blocks
   • Manage glossary terms
   • Preview changes in real-time