The changelog shows readers what's new, improved and fixed in each release of your product. Each knowledge base has its own changelog at yoursite.com/docs/changelog/.
📷 Image placeholder: a changelog page showing two releases with New, Tweaked and Fixed badges.
Turn on the changelog
Open the knowledge base settings
Go to PinkDocs → Knowledge Bases and click Edit on the knowledge base.
Enable the changelog
Turn on Changelog and click Update.
📷 Image placeholder: the Changelog setting turned on for a knowledge base.
Visit your changelog
Open yoursite.com/docs/changelog/ to check the page is live.
Add a release
Open the changelog
Go to PinkDocs → Changelog and click Add Release.
Enter the version and date
Enter the version number, such as 2.1.0, and the release date.
Add each change
Add one line per change and give it a badge:
| Badge | Use it for |
|---|---|
| New | A new feature |
| Tweaked | An improvement to an existing feature |
| Fixed | A bug fix |
📷 Image placeholder: the Add Release form with three changes and their badges.
Publish the release
Click Publish. The release appears at the top of your changelog.
Write clear changelog entries
- Start each entry with what changed for the reader, such as Added dark mode to the AI chat.
- Keep each entry to one line.
- Link to the doc that explains a new feature.
Show releases on your homepage
Add the Changelog block to your docs homepage to show your latest releases. Set Max entries to choose how many releases appear, and turn on Show view all link to link to the full changelog.
Common questions
Yes. Open PinkDocs → Changelog, click the release and make your changes.
Yes. Each knowledge base has its own changelog, so create one knowledge base per product.