"Edit this page on Github" links give a 404 not found on Github
Metadata
Current evaluation
Snapcraft documentation edit links were traced to an upstream canonical-sphinx path bug; the current docs stack requires canonical-sphinx 0.6+, incorporating the 0.4.0 fix.
Suggested action: close resolved
Reason: The maintainer identified canonical/canonical-sphinx#56 as the upstream bug and noted that the fix shipped in canonical-sphinx 0.4.0. The current docs/requirements.txt requires canonical-sphinx~=0.6, so Snapcraft now incorporates that fix.
Evaluated by: mr-cal-bot
Impact:
30
Quick Win:
22
Complexity:
20
Confidence:
94
Actionability:
90
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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
30
Quick Win:
22
Complexity:
20
Confidence:
94
Actionability:
90
|
close resolved | Snapcraft documentation edit links were traced to an upstream canonical-sphinx path bug; the current docs stack requires canonical-sphinx 0.6+, incorporating the 0.4.0 fix. | |
| qwen/qwen3.6-35b-a3b |
Impact:
20
Quick Win:
16
Complexity:
10
Confidence:
85
Actionability:
90
|
close resolved | Broken 'Edit this page on GitHub' links in Snapcraft docs. Upstream fix released in canonical-sphinx 0.4.0; Snapcraft now uses canonical-sphinx ~=0.6. | |
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
21
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. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical-sphinx#56
(confidence 99%)
The issue discussion explicitly identifies #56 as the upstream canonical-sphinx bug.
-
Likely Fixed By:
canonical-sphinx#74
(confidence 88%)
A parallel Rockcraft report was fixed by the canonical-sphinx edit-link path correction in #74.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #705 "Edit this page on github" links in the docs seem to be broken | rockcraft | closed | Broken "Edit this page on GitHub" doc links traced to bad path composition in the canonical-sphinx theme footer; fixed upstream in canonical-sphinx#74 and shipped via a canonical-sphinx dependency bump (#993). | |
| #780 "Edit this page on GitHub" links broken | rockcraft | closed | Duplicate of rockcraft#705; fixed by canonical-sphinx#74, which corrected the shared documentation theme's edit-link path and restored the missing slashes. |