docs: fix canonical URL
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a fix to dynamically generate version-specific canonical URLs in the documentation configuration. The update improves search engine indexing by appending the correct version path and excludes specific 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 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. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged documentation update to use canonical-sphinx. Approved by two reviewers, passed CI and codecov checks, and successfully integrated into the codebase. |