feat: use versioned form of doc urls
Metadata
Current evaluation
Merged PR #634 updated Rockcraft error messages and init templates to use versioned documentation URLs, including the running version in links.
Resolution: closed resolved
Reason: PR #634 was merged in commit f0d7570b, changing documentation links in errors and init templates to versioned /en/<version>/ URLs. This directly implements the requested behavior.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This updates the links used for errors, but also for init templates.
Example with a fake version `9.9.9`:
```
❯ rockcraft init --profile=flask-framework
Created 'rockcraft.yaml'.
Go to https://documentation.ubuntu.com/rockcraft/en/9.9.9/reference/extensions/flask-framework to read more about the 'flask-framework' profile.
❯ cat rockcraft.yaml
name: rockcraft
# see https://documentation.ubuntu.com/rockcraft/en/9.9.9/explanation/bases/
# for more information about bases and using 'bare' bases for chiselled rocks
base: ubuntu@22.04 # the base environment for this Flask application
...
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #634 updated Rockcraft error messages and init templates to use versioned documentation URLs, including the running version in links. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #634 (f0d7570b), updating error messages and init templates to use versioned documentation URLs such as /rockcraft/en/9.9.9/. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #634 (f0d7570b): error messages and init templates now use versioned documentation URLs such as /rockcraft/en/9.9.9/. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged. Updates documentation URLs in error messages and rockcraft init templates to use versioned paths. Approved by two reviewers, passed CI, and modified eight files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updates documentation links in error messages and init templates to use versioned URLs for accurate release-specific references. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2958 fix: update rockcraft documentation link to new url | charmcraft | merged | Merged PR #2958 updating legacy rockcraft documentation links from documentation.ubuntu.com to ubuntu.com/containers/rockcraft/docs across 10 files. | |
| #247 docs: include some docs from craft-parts | rockcraft | closed | PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts"). | |
| #515 refactor(docs): use more docs from craft-parts | rockcraft | merged | Merged #515 refactored Rockcraft docs to reuse Craft Parts pages via direct TOC links or local includes (commit 5c2263f1). | |
| #368 Support versioned doc urls | craft-application | closed | Implemented version-aware documentation URL rendering in merged PR #380 (commit 600cec0e), building on the base URL support introduced by #361. | |
| #764 feat: update 'rockcraft init' base to 24.04 | rockcraft | merged | Merged PR #764 as commit 7b1936db, updating the `rockcraft init` template base from Ubuntu 22.04 to 24.04 and fixing #748. | |
| #1312 'rockcraft init --profile' links to non-existent versioned docs (1.20.0 URLs return 404) | rockcraft | closed | Fixed by requiring craft-application >=7.2.0, producing major-version documentation links, and adding a regression test. | |
| #559 docs: use canonical-sphinx | rockcraft | merged | Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.txt. | |
| #310 docs: fix url of rockcraft format | rockcraft | merged | Merged in canonical/rockcraft#310 via commit 8145238e, correcting the Rockcraft format URL and resolving the convert-to-pebble-layer.rst linkcheck failure. | |
| #668 Docs: Harmonize README with template | rockcraft | closed | Rockcraft's README was harmonized with the Craft project template by merged PR canonical/rockcraft#881 (commit dc33814c, +90/-189). Maintainer medubelko closed #668 on 2025-09-13 citing that PR. | |
| #584 Wrong Rockcraft version in readthedocs docs | rockcraft | closed | Fixed by merged PR #586: Read the Docs now fetches tags and labels unreleased documentation as dev instead of showing an outdated patch version. |