docs: fix canonical URL
Metadata
Current evaluation
Merged #1055 in commit 52ef86e3, updating docs to use RTD’s versioned canonical URL and exclude generated pages from the sitemap.
Resolution: closed resolved
Reason: PR #1055 was approved with all CI checks passing and merged as commit 52ef86e3. The change derives canonical URLs from the Read the Docs version and excludes generated pages from the sitemap.
Evaluated by: mr-cal-bot
No scores available.
Issue body
The canonical URLs in this documentation currently don't specify a version.
This can confuse search engines and impair SEO. I have updated the conf.py file to:
- pull the correct canonical URL from RTD
- append only the page's path, as the canonical URL will include the correct version
- exclude certain generated pages from the sitemap
This change has already been implemented in the [snapcraft](https://github.com/canonical/snapcraft/pull/5901) docs.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/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.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #1055 in commit 52ef86e3, updating docs to use RTD’s versioned canonical URL and exclude generated pages from the sitemap. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #1055 (commit 52ef86e3): Rockcraft docs now use RTD’s versioned canonical URL and exclude generated pages from the sitemap. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation fix to update canonical URLs in conf.py. The change pulls correct versioned URLs from RTD, appends page paths, and excludes generated pages from the sitemap to improve SEO. Approved by reviewers and passed all CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged fix updating conf.py to dynamically pull canonical URLs from Read the Docs, append only the page path, and exclude generated pages from the sitemap, resolving SEO issues caused by missing version specifications. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#5901
(confidence 99%)
The PR cites this equivalent implementation as the precedent.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5901 docs: fix canonical URL | snapcraft | merged | Merged PR #5901 (commit 02d84057a), updating docs to use RTD's versioned canonical URLs and omit generated pages from the sitemap. | |
| #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. | |
| #2736 docs: fix the title in the toc | charmcraft | merged | Merged #2736 as commit 3e6cd690, removing obsolete html_title from the docs TOC so the default theme can process the title correctly. | |
| #1250 Fixed links to doc | snapcraft | merged | Merged as commit c222df587 (docs: fixed links to doc), removing 3 stale README links left pointing at the doc/ folder deleted by #1227. |