1. Where the Changelog Is Defined #
The primary changelog is kept in your plugin’s:
readme.txtunder a== Changelog ==section.
There, each release is documented as:
- A version heading:
- e.g.
= 1.1.0 =
- e.g.
- Followed by bullet points describing:
- New features (e.g., “Added AI Writer – Gutenberg sidebar.”).
- Improvements (e.g., “Improved Forms AI Pro search grounding.”).
- Bug fixes (e.g., “Fixed Telegram human handoff 403 when logged out.”).
Your longer PDF documentation is versioned in sync with the plugin and reflects the same features/fixes described in readme.
image IMAGE PLACEHOLDER: Screenshot of the Changelog part of readme.txt, highlighting version headings (
= 1.0.0 =,= 1.1.0 =) and bullet lists of changes. IMAGE image
2. How the Changelog Relates to Docs #
Each major section in your PDF (Chatbot, LLM Index, Forms, Telegram, Auto-Reply, AI Writer, Debug Logs) corresponds to features that appear in certain versions in the changelog.
As you add or change features:
- You:
- Update the code.
- Update the PDF documentation.
- Add entries in the readme changelog.
That means, for example:
- If you add a new setting to Forms AI Pro (e.g. an extra provider filter or context source option), you’ll:
- Document it in the Forms chapter.
- Add a bullet like “New: extra context source option for Forms AI Pro” under the new version in Changelog.
3. How Users Should Use the Changelog #
On your documentation page, guide users to:
- Check the Changelog before updating
- To see:
- If there are breaking changes or required configuration updates.
- If new modules (like AI Writer or Telegram improvements) are included.
- To see:
- Map changes to modules
- Tell them which documentation section explains each new or changed feature:
- e.g. “For the new Telegram availability options added in X.Y.Z, see Telegram – Article 4: Availability, Login-only, Consent & Rate Limiting.”
- Tell them which documentation section explains each new or changed feature:
- Use the Changelog to debug regressions
- If something behaves differently after an update:
- Check what changed in that version.
- Then go to that module’s doc article and verify configuration.
- If something behaves differently after an update:
4. Keeping Docs & Changelog in Sync #
Your PDF and readme are clearly written to stay in sync with the plugin:
On your documentation landing page, you can tell users:
- “This documentation corresponds to Davix AI Engine version X.Y.Z, as listed in the Changelog.”
- “If you are using a different version, some screenshots/fields may differ; always refer to the Changelog to see what changed.”
image IMAGE PLACEHOLDER: Screenshot of your online documentation page header where the current plugin version is shown and matches the top entry of the Changelog. IMAGE image
