← Back to issue list

"Edit this page on Github" links give a 404 not found on Github

View original Github issue

Metadata

Project
snapcraft
Number
#5244
Type
issue
State
open
Author
Sophie-Pages
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed
—

Current evaluation

Snapcraft readthedocs 'Edit this page on Github' links 404. Triaged as a doc bug; root cause is an upstream canonical-sphinx bug fixed in 0.4.0. Repo now pins canonical-sphinx~=0.6, so the fix is applied and the links should work.

Suggested action: close stale

Reason: mr-cal noted the upstream fix shipped in canonical-sphinx 0.4.0 and 'needs to be updated in Snapcraft'; the repo now pins canonical-sphinx~=0.6 in both docs/requirements.txt and pyproject.toml, so the 0.4.0 fix is included and the 404 edit links are no longer reproducible. The issue is triaged and resolved, so it can be closed.

Impact: 25 Quick Win: 21.25 Staleness: 75 Complexity: 15 Confidence: 80 Support Request: 10

Issue body

### Bug Description The "Edit this page on Github" links in [Canonical Snapcraft readthedocs](https://canonical-snapcraft.readthedocs-hosted.com/en/stable/) look broken and don't redirect to the right path on Github. ### To Reproduce Examples of pages where the links don't work: - https://canonical-snapcraft.readthedocs-hosted.com/en/stable/reference/parts_steps/ - https://canonical-snapcraft.readthedocs-hosted.com/en/stable/reference/components/ - https://canonical-snapcraft.readthedocs-hosted.com/en/stable/howto/select-a-build-provider/ - https://canonical-snapcraft.readthedocs-hosted.com/en/stable/howto/architectures/ ### Environment Not applicable. ### snapcraft.yaml ```yaml Not applicable. ``` ### Relevant log output ```shell Not applicable. ``` ### Additional context _No response_

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 25
Quick Win: 21.25
Staleness: 75
Complexity: 15
Confidence: 80
Support Request: 10
close stale Snapcraft readthedocs 'Edit this page on Github' links 404. Triaged as a doc bug; root cause is an upstream canonical-sphinx bug fixed in 0.4.0. Repo now pins canonical-sphinx~=0.6, so the fix is applied and the links should work.
qwen/qwen3.6-35b-a3b
Staleness: 75
Complexity: 15
Confidence: 85
Support Request: 0
keep open Triaged documentation bug where Edit this page on GitHub links return 404s. An upstream fix exists in canonical-sphinx 0.4.0, but the dependency update in Snapcraft has not yet been applied.
qwen3.6-35b-a3b-mtp-q6
Staleness: 35
Complexity: 10
Confidence: 90
Support Request: 0
keep open Broken edit links in Snapcraft docs. Triaged and identified as an upstream canonical-sphinx bug. Fix released in v0.4.0, awaiting version update in Snapcraft.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 90
Support Request: 0
keep open Broken edit page links in Snapcraft documentation return 404 errors. Triaged. An upstream fix exists in canonical-sphinx 0.4.0, pending a dependency update in Snapcraft to resolve the issue.

Update history

No update history recorded yet.

Related work

  • Caused By: canonical/canonical-sphinx#56 (confidence 90%)

    Upstream bug explicitly referenced in the issue; fixed in canonical-sphinx 0.4.0, which the repo now exceeds (pinned ~=0.6).

Related issues

Issue Project State Summary Similarity
#705 "Edit this page on github" links in the docs seem to be broken rockcraft closed Broken documentation edit links were fixed after incorrect path composition in the Sphinx theme footer was corrected. Merged into canonical-sphinx via PR #74 and deployed. Edit links now work correctly at the top of documentation pages.
78%