← Back to issue list

docs: [debug a snap] mention that snappy-debug is a snap, and fix broken 'Debugging snaps' link

View original Github issue

Metadata

Project
snapcraft
Number
#5726
Type
issue
State
open
Author
tonyespy
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

Docs request for debug-a-snap page: add an 'install snappy-debug' step and fix the broken 'Debugging snaps' link. Link half already fixed by intersphinx commit e81c28a30 (#6165); install step still missing, PR #6457 closed unmerged.

Suggested action: keep open

Reason: One of the two requests is already done: docs/how-to/debugging/debug-a-snap.rst now ends with ':external+snap:ref:`how-to-guides-fix-common-issues-debug-snaps`' after commit e81c28a30 (#6165), which wak327 confirms. The other request is still unfixed at HEAD — the snappy-debug steps still read '1. In a terminal, run ``snappy-debug``' with no install step — and the maintainer's own PR #6457 was closed without merge, so the small remaining docs edit is still valid and should stay open. Trivial, well-scoped change with an existing patch, hence high actionability but minimal impact.

Evaluated by: mr-cal-bot

Impact: 22 Quick Win: 18 Complexity: 5 Confidence: 88 Actionability: 85

Issue body

*Please describe the question or issue you're facing with "Debug a snap - Snapcraft 8.11.2 documentation".* 1. It would be helpful to add a "install the snap" to the list of instructions for how to use `snappy-debug` 2. Clicking the `Debugging snaps` link at the end of the page just causes the page to be redisplayed (i.e. it doesn't display a different page) --- *Reported from: https://documentation.ubuntu.com/snapcraft/stable/how-to/debugging/debug-a-snap/?_gl=1*gxbgiu*_gcl_aw*R0NMLjE3NTAxNzQxMDkuQ2p3S0NBandwTVRDQmhBLUVpd0FfLU1zbVgwaEZ3UVRhWk4wV0Nyekx4bTFhSzk5YkwtVDRwOGkwUTJlOUNJam05Tm5YbmNSYVlzYjBSb0N1Ym9RQXZEX0J3RQ..*_gcl_au*OTQwMDE3MjYwLjE3NDg1MzgzMjY.*_ga*MzAyNzgwMDEwLjE3Mjk5NTA0MDE.*_ga_5LTL1CNEJM*czE3NTYxNTE0NTIkbzI3MiRnMSR0MTc1NjE1MTUxNCRqNjAkbDAkaDA.*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 22
Quick Win: 18
Complexity: 5
Confidence: 88
Actionability: 85
keep open Docs request for debug-a-snap page: add an 'install snappy-debug' step and fix the broken 'Debugging snaps' link. Link half already fixed by intersphinx commit e81c28a30 (#6165); install step still missing, PR #6457 closed unmerged.
stealth/space-bunny-alpha
Impact: 22
Quick Win: 18
Complexity: 8
Confidence: 88
Actionability: 90
keep open Docs request for debug-a-snap page: add an 'install snappy-debug' step and fix the broken 'Debugging snaps' link. Link already fixed via intersphinx (e81c28a30); install step has open PR #6457.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 80
Actionability: 80
keep open Documentation issue: snappy-debug instructions omit installation step, and a 'Debugging snaps' link is broken.
qwen/qwen3.8-27b
Impact: 20
Quick Win: 18
Staleness: 60
Complexity: 10
Confidence: 55
Support Request: 20
keep open Docs request for 'Debug a snap' page: add an 'install the snap' step to the snappy-debug instructions, and fix the broken 'Debugging snaps' link. The broken link appears already fixed via intersphinx (PR #6165), but the missing install step is still absent from the current docs.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 15
Confidence: 85
Support Request: 10
needs triage Documentation update request to clarify snappy-debug installation and fix a broken internal link on the debugging page. Unacknowledged and inactive for over 11 months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 75
Support Request: 5
needs triage Requested documentation updates to clarify snappy-debug installation and fix a broken link on the Debug a snap page. Unacknowledged and inactive for over 10 months.

Update history

Date Change
updated

Related work

Related issues

Issue Project State Summary Similarity
#6457 docs(debug): add the step to install snappy-debug snapcraft closed PR #6457 was closed unmerged without review; the missing snappy-debug installation instructions did not land, and issue #5726 remains open.
77%
#5373 docs: migrate 'debug a snap' snapcraft merged Merged the “debug a snap” documentation migration, updating five files (+206/−37); landed as commit 2dfb26407.
74%
#1558296 snappy build-apps broken link to devel ref page snapcraft (launchpad) closed Broken 'Snappy developer reference' link in docs/intro.md (build-apps page) was fixed by ubuntu-core/snapcraft PR #456, merged as commit 3360bff71; Launchpad bug closed by ~sergiusens referencing that PR.
72%