ReadMe

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Add Post To Changelog

Keep a running record of your latest updates

Need a place for a Changelog, Release Notes, Announcements, or a Blog? Navigate to Documentation > Changelog.

Changelog Tags

Changelog uses the same editor as the Documentation component with the addition and five changelog tags.

The author and time since posting is displayed to the right.

The author and time since posting is displayed to the right.

Metadata

Edit the meta data anytime with the ⚙️ icon to change:

  • Post Date
  • Posted By (anyone in the project)
  • Tags

Changelog posts are ordered by date, so if you would like to change the order all you need to do is to update the post date.

Main Page

On the main page, the changelog tags from each post are summarized as "X changes" in green.


Add Post To Changelog


Keep a running record of your latest updates

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.