← Back to issue list

"Edit this page on github" links in the docs seem to be broken

View original Github issue

Metadata

Project
rockcraft
Number
#705
Type
issue
State
closed
Author
james-garner-canonical
Labels
—
Created
Updated
Closed

Current evaluation

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).

Resolution: closed resolved

Reason: Maintainer medubelko reported the root cause was the theme footer's path composition, tracked in canonical/canonical-sphinx#56, and fixed by PR canonical/canonical-sphinx#74; after a rockcraft dependency bump the edit button works again, so the issue was closed in September 2025.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Request type Fix ### What needs to get done "Edit this page on github" links in the docs seem to be broken. I expected that clicking the link would take me through the equivalent of clicking the edit button on the appropriate document in this repo (i.e. create a fork and take me to the file for editing). These links should probably be updated to reflect the current project structure, or removed if this is no longer a supported way of contributing changes to the documentation. ### Documentation location https://documentation.ubuntu.com/rockcraft/en/latest ### Additional information Clicking the "Edit this page on github" links in the tutorial results in a github 404 ![image](https://github.com/user-attachments/assets/5512a912-ef1a-4405-b25d-6a141fc8ab26) To reproduce: 1. Navigate to this page https://documentation.ubuntu.com/rockcraft/en/latest/tutorial/hello-world/ 2. Click the [Edit this page on github](https://github.com/canonical/rockcraft/edit/maindocstutorial/hello-world.rst) link at the bottom

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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).
stealth/space-bunny-alpha — closed resolved Fixed in canonical-sphinx#74 by correcting the theme’s edit-link paths. The maintainer confirmed the edit button was working again after several patches.
qwen/qwen3.6-35b-a3b — — 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.
qwen/qwen3.6-35b-a3b — — Broken documentation edit links stemmed from incorrect path composition in the Sphinx template footer. Fixed via canonical-sphinx PR #74. The updated theme was deployed, restoring functionality, and the issue was closed.
qwen/qwen3.6-35b-a3b — — Broken documentation edit links were caused by incorrect path composition in the canonical-sphinx theme footer. The fix was merged in canonical-sphinx PR 74, correcting the template paths. The issue is closed as resolved.
qwen3.6-35b-a3b-mtp-q6 — — Broken documentation edit links resulted from incorrect path composition in the Sphinx template footer. Resolved via canonical-sphinx PR #74 and deployed after a theme version bump. Edit functionality now works as expected.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical-sphinx#74 (confidence 92%)

    Upstream theme PR that corrected the edit-link path composition; cited by the maintainer as the fix.

  • Related To: canonical-sphinx#56 (confidence 88%)

    Upstream tracking issue for the bad footer path composition, linked from the first maintainer reply.

  • Related To: rockcraft#993 (confidence 55%)

    'build(deps): update all dependencies' commit picking up the patched canonical-sphinx release; exact bump not confirmed.

Related issues

Issue Project State Summary Similarity
#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.
85%
#5244 "Edit this page on Github" links give a 404 not found on Github snapcraft open 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.
83%