docs: fix canonical URL
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update that configures conf.py to pull version-specific canonical URLs from Read the Docs, improving SEO. The change also excludes generated pages from the sitemap. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5901 docs: fix canonical URL | snapcraft | merged | 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. | |
| #36 docs: move API gen to conf.py for RTD to pick up | craft-cli | merged | Merged. Moved API documentation generation to conf.py to enable Read The Docs to build it automatically, with minor typo corrections. Approved and passed CI. | |
| #983 docs: update links | rockcraft | merged | Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures. | |
| #1302 docs: rewrite some redirects | craft-parts | merged | Merged documentation rewrite correcting several redirects to resolve recurring lint CI failures. Approved by two reviewers, passed all CI checks, and modified four files with minimal changes. | |
| #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. | |
| #188 docs: update code cov url | craft-archives | merged | Merged documentation update correcting code coverage URLs. Approved by two reviewers and passed all CI checks. Replaces redirect-dependent links with direct URLs for reliability. | |
| #1274 docs: update intersphinx paths | rockcraft | merged | Merged documentation update correcting intersphinx mapping paths for the 12-factor docs after a URL migration and RTD project deletion. Approved by two reviewers, passed all CI checks, and modified one file. | |
| #4766 docs: use canonical-sphinx | snapcraft | merged | Merged documentation update switching to canonical-sphinx. Consolidated requirements files and added docs_requires to setup.py. Approved by two reviewers with passing CI checks. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged documentation update to adopt canonical-sphinx and remove unused extensions. Approved by two reviewers, passed CI, and modified four files (+30/-83 lines). | |
| #1104 docs: update links | craft-parts | merged | Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures. |