Overview

Experience a whole new way to create, edit, and publish your documentation with ReadMe's Editing UI! This innovative interface brings the editing process right to your docs project, allowing you to visualize your changes in real-time. You’ll have the power to see exactly how your updates will appear to your users before they are live—making the entire experience smoother and more intuitive. Get ready to transform your documentation workflow!

Key Benefits

1. Streamlined Documentation Process

   • Create, edit, and publish documentation directly on your docs site.
   • See exactly how changes will look for your customers before they go live.
   • Make quick updates right where you spot them.

2. Unified Experience

   • Same UI for both admins and users.
   • Edit on the fly when you catch needed updates.
   • Navigate seamlessly between editing and viewing modes.

3. Enhanced Search

   • Higher-quality search results.
   • More accurate content discovery.
   • Better developer experience.

Editing UI Features

✏️ Edit Mode

• Toggle between Edit and View modes directly on your live site.
• Access the full editor, sidebar, and page navigation functionalities.
• Create and edit Guides pages, Recipes, Changelog posts, and Custom Pages seamlessly.

♻️ Content Settings

• Manage Reusable Content and Glossary directly in the editing UI.
• Seamlessly add or edit glossary terms.
• Use << to search and insert glossary terms in your docs.
• Access Content Settings from the top right navigation, indicated by a content icon.

🎨 Appearance Settings

• Preview visual changes like brand, logo, and site navigation updates in real-time.
• Access Appearance Settings from the top navigation, indicated by a paintbrush icon.
• See your updates reflected immediately on the live site.

➕ Versions

• Manage versions through the dropdown in the editing UI menu.
• Allow end users to toggle between active versions on the hub.
• Maintain version-specific content easily.

⚙️ Project Menu

• Navigate effortlessly between editing docs and managing project/account settings.
• Access all project configuration options from one convenient location.
• Streamline your documentation workflow.