changelog docs
Domain: Documentation
🎯 Motivation
changelog docs present version history in a user-friendly format, often integrated into your documentation site. They help users understand what changed between versions and whether they need to update.
📋 Concrete Example
A CHANGES.rst file is included in your sphinx docs via .. include:: ../CHANGES.rst, rendering the full version history as a readable page on your docs site.
🔗 Analogy
changelog docs are like the “patch notes” screen in a game. Players (users) check it before updating to see what improved and what might break.