docs: fix canonical URL
Metadata
Current evaluation
Merged PR #5901 (commit 02d84057a), updating docs to use RTD's versioned canonical URLs and omit generated pages from the sitemap.
Resolution: closed resolved
Reason: PR #5901 was merged as commit 02d84057a. It derives canonical URLs from RTD, appends each page path, and excludes generated pages from sitemap indexing.
Evaluated by: mr-cal-bot
No scores available.
Issue body
The canonical URLs in our documentation currently don't specify a version.
```
<link rel="canonical" href="https://documentation.ubuntu.com/snapcraft/">
```
This is detrimental to getting our stable docs indexed by search engines. I've 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
I'll be opening similar PRs in the other craft apps.
---
- [X] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/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.
- [ ] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #5901 (commit 02d84057a), updating docs to use RTD's versioned canonical URLs and omit generated pages from the sitemap. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5901 in commit 02d84057a, fixing docs to use RTD's versioned canonical URLs and excluding generated pages from the sitemap. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs PR merged as commit 02d84057a: conf.py now derives the canonical URL from RTD's versioned base URL, appends only the page path, and excludes generated pages from the sitemap. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in #5901 (commit 02d84057a): docs now use RTD’s versioned canonical URLs and exclude generated pages from the sitemap. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as canonical/snapcraft#5901 (commit 02d84057a), fixing versionless canonical documentation URLs and excluding generated pages from the sitemap. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged. Updated conf.py to dynamically fetch the correct versioned canonical URL from Read the Docs, resolving search engine indexing issues. The change also excludes specific generated pages from the sitemap. Approved and merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a fix to dynamically set version-specific canonical URLs in conf.py, improving SEO indexing. The update pulls the correct RTD version path and excludes certain generated pages from the sitemap. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1055 docs: fix canonical URL | rockcraft | merged | Merged #1055 in commit 52ef86e3, updating docs to use RTD’s versioned canonical URL and exclude generated pages from the sitemap. | |
| #2327 docs: fix some links | charmcraft | merged | Merged PR #2327 (f829b25d), correcting broken documentation links in two files with a +3/-3 change. | |
| #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. | |
| #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. | |
| #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). | |
| #291 docs: fix linkcheck issues with documentation | craft-store | merged | Merged PR #291 fixed documentation linkcheck failures in two files, resolving #290. | |
| #367 docs(rtd): switch to extensionless URLS | starbase | merged | Merged PR canonical/starbase#367, updating RTD docs to use extensionless URLs in line with recent Rockcraft and Snapcraft changes. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged PR #325 in commit 8ca97e1a, migrating the docs to canonical-sphinx and removing unused extensions and configuration. | |
| #1030 docs: fix some URL issues in docs and CLI messages | rockcraft | merged | Merged PR #1030 as commit f22480ec, correcting URLs in 11 documentation and CLI-message files (+28/-25); all CI checks passed. | |
| #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. |