How to create Changelogs

Summary: Docy provides a dedicated "Changelogs" feature for documenting project updates. It offers a user-friendly design and intuitive interface for creating and displaying version-specific change logs.

Changelogs

A changelog is a log or record of all significant changes made to a project or product. It typically includes records of changes such as bug fixes, new features, changes to existing features, and additions or removals of content. Some open-source projects include a changelog as one of the top-level files in their distribution for transparency.

Traditionally, a changelog included all changes made to a project. However, the “Keep a Changelog” site now advocates that a changelog should not contain all changes but rather a curated, chronologically ordered list of notable changes for each project version.

Creating Changelogs in Docy

We have developed an interactive changelog system for you in the Docy – Documentation WordPress theme. Check out the design of the changelogs below –

How to create Changelogs

1. You will find a custom menu type named “Changelogs” in your WordPress admin dashboard. 
2. Navigate to Changelogs Add New

You can start adding you’re changelogs in versions by simply creating a new post by clicking ”Add New”.

After adding changelogs, you can publish the changelog for each version on the front end of your website in a streamlined layout. Use the available Elementor widget named “Changelogs,” which can display the changelogs. Insert that widget into the page and select your newly created changelogs.

Alternative Way to Create Changelog

An alternative—and more streamlined—way to create changelogs is directly via the Gutenberg editor:

• Log in to your WordPress dashboard.
• Go to Plugins add new Search changeloger
• Install and activate the plugin.
• Go to the Gutenberg editor for the page where you’d like to insert the changelog.
• Add a new block and search for the “Changeloger” block.
• Click on it to insert the Changeloger component.

You’ll be presented with three input options:

• Upload Changelog (.txt file)
• Plain Text
• Load Sample Data

Choose the method that suits your workflow, fill in the relevant information, and save the page. Your changelog will then be live on your site using the Gutenberg system.

Note:
We are currently transitioning to a new changelog creation system based entirely on the Gutenberg editor. As part of this update, the Custom post-based method will be fully phased out. We’ve also integrated the Changelog plugin directly into the Gutenberg editor, ensuring a streamlined and future-proof workflow. Going forward, all changelogs will be managed using this simplified and modern Gutenberg-based approach.