How to create Changelogs

Summary: Docy now provides a modern Gutenberg-based “Changeloger” feature for documenting project updates. The previous custom post–based “Changelogs” system has been fully removed. From now on, all changelogs must be added using the Changeloger block within the Gutenberg editor.

What is a Changelog?

A changelog is a log or record of all significant changes made to a project or product. It typically includes records such as:

• Bug fixes
• New features
• Changes to existing features
• Additions or removals of content

Traditionally, changelogs included every change, but the current best practice (inspired by Keep a Changelog) is to list only notable changes in a clear, chronological order.

Creating Changelogs in Docy

We have transitioned completely to a Gutenberg-based Changeloger system in the Docy – Documentation WordPress theme.

Follow these steps to create and display changelogs:

• Log in to your WordPress dashboard.
• Go to [direction] Plugins > add new > Search changeloger [/direction]
• 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:

• This change ensures a simplified, future-proof workflow.
• The old “Changelogs” menu and custom post method have been removed.
• The only supported method now is using the Changeloger block in the Gutenberg editor.