ReadMe’s New UI
As a part of ReadMe Refactored, we introduced a redesigned ReadMe.
✨ REFACTORED EXCLUSIVE
This feature is currently only available in the ReadMe Refactored experience. If you're using the Legacy platform, you'll need to upgrade to Refactored to access this functionality. Learn more about ReadMe Refactored →
Key Benefits
- Create, edit, and publish your docs without switching tabs.
- More accurate look at your docs before publishing.
- More accurate search results.
What’s Changed?
View & Edit Modes
Viewing and editing your docs have been reorganized to the navigation. From the navigation you can access all your settings, versions, your docs, edit, my developers, and AI settings.
The glossary shortcut has changed to <<.
Settings, Appearance, & Versions
Settings are located in the top-left menu. You can now also preview appearance changes to your theme, brand, navigation, and CSS before saving. Versions live separately next to the settings.
Search
You can search for settings—including their previous names.
What settings moved where?
Several features still exist in our legacy dashboard and will be ported over gradually. You can access them from your legacy dashboard and the links are available from the new ReadMe UI.
Legacy | New UI | |
|---|---|---|
Home | ||
My Developers | ||
Metrics | ||
Project Settings | Renamed “General” | |
Error Pages | ||
Health Check | ||
Personalized Docs | ||
AI Settings | ||
API Keys | ||
Internal Documentation | Moved to “General” | |
Manage Team | ||
Custom Login | Renamed “End User Login” | |
Custom Domain | ||
Integrations | ||
Labs | ||
Manage Plan | ||
Theme Editor | Renamed “Theme” | |
Site Navigation | Moved to “Header & Footer” | |
Site Footer | Moved to “Header & Footer” | |
Changelog | ||
API Reference | ||
Custom Stylesheet | Moved to “CSS, JS, HTML” | |
Custom JavaScript | Moved to “CSS, JS, HTML” | |
Custom Include Tags | Moved to “CSS, JS, HTML” | |
Owlbot AI | ||
Versions | ||
Suggested Edits | Not available1 | Not available1 |
Reusable Content | ||
Landing Page | ||
Reusable Components NEW | ||
Git Connection NEW |
Updated 9 days ago