docs: fix version string for 3.x
Metadata
Current evaluation
Merged #2831 to display the 3.x major/minor version in docs titles; the latest branch remains labeled dev after Read the Docs slug simplification.
Resolution: closed resolved
Reason: PR #2831 was approved and merged, updating the version-string logic used by local, pull-request, and branch documentation builds.
Evaluated by: mr-cal-bot
No scores available.
Issue body
With this change, all local, PR, and branch builds will show the major and minor version in the docs title. The only exception is the 'latest' branch build, which will show 'dev' as the version.
This was brought about by the simplification of our RTD version slugs.
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md).
- [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [ ] I've successfully run `make lint && make test`.
- [ ] I've added or updated any relevant documentation.
- [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #2831 to display the 3.x major/minor version in docs titles; the latest branch remains labeled dev after Read the Docs slug simplification. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs update so local, PR, and branch builds show the 3.x major/minor version in the title; latest displays dev, following Read the Docs slug simplification. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged docs fix for 3.x version string. Local, PR, and branch builds now show major and minor version in the title, while latest shows 'dev'. Aligns with simplified Read the Docs slugs. Approved and merged. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
0
Complexity:
5
Confidence:
85
|
needs review | Updates documentation version string display for 3.x builds to align with simplified RTD slugs. Currently approved by one reviewer but has one unresolved comment and several failing CI checks on slow tests and lint. |
Update history
| Date | Change |
|---|---|
| updated | |
| created |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #588 docs: fix version in title | starbase | merged | Merged docs fix (commit 23328cd): docs page titles now display major.minor version for local, PR and branch builds; only the 'latest' branch shows 'dev', following the RTD version slug simplification. | |
| #1334 docs: fix version string on latest | rockcraft | merged | Merged PR #1334 fixed docs version strings: local, PR, and branch builds show major.minor, while latest shows dev. Commit: b2bc69ce. | |
| #6387 docs: fix version on 'latest' | snapcraft | merged | Merged PR #6387 via commit a67bdcd1f, fixing docs titles to show major.minor for local, PR, and branch builds while displaying dev for latest. | |
| #2830 docs: fix version string for 'latest' | charmcraft | merged | Docs-only PR merged: RTD page titles now show major.minor for local/PR/branch builds, with 'latest' branch showing 'dev', following simplification of RTD version slugs (+2/-6 in one file). | |
| #2832 docs: fix version string for 4.x | charmcraft | merged | Merged #2832 corrected docs title versioning for Charmcraft 4.x: local, PR, and branch builds show major/minor; the latest branch shows dev. | |
| #586 docs: fix incorrect version in documentation | rockcraft | merged | Merged in #586 via commits 0ffc2395 and d5da1878, fixing #584 by fetching tags for Read the Docs and labeling unreleased docs as dev. | |
| #1335 docs: fix version string for 1.x | rockcraft | merged | Merged into the 1.x hotfix branch so docs show major.minor for local, PR, and branch builds, and dev for latest; this parallels #1334 on main. | |
| #6295 docs: fix version numbering | snapcraft | merged | Merged #6295 (commit 8456b4421), fixing docs version numbering to use Read the Docs branch metadata and keep local and RTD builds consistent. | |
| #1189 docs: format doc version as major.minor | rockcraft | merged | Merged into main as fc0e073a, replacing #1185; documentation now renders release versions as major.minor and labels latest RTD builds as dev. | |
| #2649 docs: format doc version as major.minor | charmcraft | merged | Merged in PR #2649 (commit fa566418): docs/conf.py now derives the Sphinx release string as major.minor from charmcraft.__version__ instead of using the full patch version, with a 'dev' value for latest RTD builds. |