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

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Broken documentation edit links caused by incorrect template path composition were fixed in canonical-sphinx PR #74. Updating the theme version restored the functionality. Issue closed.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#5244 "Edit this page on Github" links give a 404 not found on Github snapcraft open 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.
78%
#780 "Edit this page on GitHub" links broken rockcraft closed Superseded by #705. The broken edit links are a known issue tracked elsewhere. No fix applied in this report.
71%