---
updatedAt: 2026-09-17T07:50:06.000Z
agentTools:
  siteIndex: https://docs.readme.com/llms.txt
  siteSearch: https://docs.readme.com/agentSearch?query=term1%20term2
  projectIndex: https://docs.readme.com/main/llms.txt
  projectSearch: https://docs.readme.com/main/agentSearch?query=term1%20term2
---

# Changelog

Keep a running record of your latest updates

<Callout icon="fad fa-link" theme="info">
  ### ReadMe Changelog

  [https://docs.readme.com/changelog](https://docs.readme.com/changelog)
</Callout>

Keep your end-users up to date on the latest updates and/or announcements using the Changelog.

## How It Works

### Feed

The Changelog feed displays posts from newest to oldest. New posts always appear at the top of the feed.

<Image src="https://files.readme.io/211a0f5f87700288308fb8e36c08e7846d4ae2c019add74af1f5524b82b03a0c-Changelog_Feed_1.gif" align="center" framed={true} />

### Posts

Each posts represents new updates and/or announcements. A post can include content, an author, and a post date.

***

### Customize

You can customize how your Changelog appears in **Appearance > Changelog**.

**Layout**

* Continuous: Displays the image, header, and content directly in the feed
* Collapsed: Displays the image and header only. Content expands when selected.

**Date Display**

* Exact: Show the post's publish date.
* Relative: Shows the date relative to the current day.

**Author Display**

* Choose whether to show or hide the author on each post

***

### Create a Post

In Edit Mode, you can create and edit Changelog posts in the same manner as a Guides page, with a few key differences:

* New posts automatically appear at the top of the sidebar and feed (newest to oldest).
* Nesting is not supported.
* Changelog posts are **not** versioned.

<Callout icon="fad fa-circle-info" theme="default">
  The Changelog is shared across all versions. Adding a post will add it to all versions. Deleting a post will remove it everywhere.
</Callout>

You can also assign a type to each post to help categorize updates. Available types include: Added, Fixed, Improved, Deprecated, Removed, and No type.

<Image src="https://files.readme.io/1fc0a7a1b7c0aceeb6fa2fdba05c51d2bd137651eac1cad2346ca820dd3dadfb-06d402e75f31b8d8ec11a45dffaf791a.png" align="center" framed={true} />

### Manage Metadata

You can edit metadata from the post's drop-down menu, just like a Guides page. Metadata controls how your post appears for SEO and when shared on social media.

***

## Git-Backed Changelogs

On projects with [bi-directional sync](https://docs.readme.com/main/docs/bi-directional-sync) enabled, changelogs are stored in your Git repository under the `changelogs/` directory on the `main` branch. You can write a changelog as a Markdown file, commit it, and bi-directional sync brings it into ReadMe. Edit it in ReadMe, and the change syncs back to the repo.

<Callout icon="fad fa-circle-info" theme="default">
  Changelogs are unversioned and live only on `main`. They do not appear on branches and do not change when you switch docs versions.
</Callout>

### File Structure

Changelog files use the following frontmatter:

```yaml Markdown
---
title: string        # Title of the changelog post
author: string       # Author name displayed on the post
date: string         # Publish date (e.g., "2025-01-15")
type: string         # Post type: Added, Fixed, Improved, Deprecated, Removed
hidden: boolean      # Visibility of the post
---

Your changelog content goes here…
```

The publish date in the frontmatter drives ordering across every surface: the changelog list, sidebar, RSS feed, sitemap, `llms.txt`, and the API. Make sure this field is set correctly.

### Page History, Diff, and Restore

Git-backed changelogs support page history, diff, and restore, matching the behavior of docs and reference pages. You can view what changed in a changelog post and recover an earlier version from the page history.

***

## :fa-rss-square: RSS Feed

Users can subscribe to your changelog. Simply add .rss to the end of your changelog URL

**yoursubdomain.readme.io/changelog.rss**

Or for custom domains:

**customdomain.com/changelog.rss**

and for enterprise projects with a custom domain:

**customdomain.com/\[project]/changelog.rss**

Once you have your URL, you can use any RSS feed widget/tool to input the URL and generate HTML to embed it ([here's](https://rss.bloople.net/) an example)!

# Sibling pages

* [Guides](https://docs.readme.com/main/docs/guides.md)
* [API Reference](https://docs.readme.com/main/docs/api-reference.md)
* [Recipes](https://docs.readme.com/main/docs/recipes.md)
* [Landing Page](https://docs.readme.com/main/docs/landing-page.md)
* [Custom Pages](https://docs.readme.com/main/docs/custom-page.md)
* [MDX](https://docs.readme.com/main/docs/mdx.md)
* [Reusable Content](https://docs.readme.com/main/docs/reusable-content.md)