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

Suggested action: keep open

Reason: The issue has two parts. The broken 'Debugging snaps' link appears already resolved: the current file uses :external+snap:ref:`how-to-guides-fix-common-issues-debug-snaps` (commit e81c28a30, PR #6165 'docs: link to snap docs with intersphinx'). However, the first request — adding an 'install the snap' step to the snappy-debug instructions — is still unaddressed; the current list still begins with '1. In a terminal, run snappy-debug.' with no install step. Because one actionable item remains open and the fix is trivial, keep it open for a small doc patch.

Impact: 20 Quick Win: 18.0 Staleness: 60 Complexity: 10 Confidence: 55 Support Request: 20

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
qwen/qwen3.8-27b
Impact: 20
Quick Win: 18.0
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 10
Confidence: 85
Support Request: 0
needs triage Documentation fix for the Debug a snap guide. Adds snappy-debug installation instructions and repairs a broken internal link to the Debugging snaps page. Currently open, unassigned, and inactive for over 290 days.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: snapcraft#6165 (confidence 60%)

    Commit e81c28a30 'docs: link to snap docs with intersphinx (#6165)' changed the 'Debugging snaps' link to an intersphinx ref, addressing the broken-link part of the issue. Date relative to the issue is unconfirmed, so confidence is moderate.

Related issues

Issue Project State Summary Similarity
#5373 docs: migrate 'debug a snap' snapcraft merged Merged documentation update migrating the 'debug a snap' guide. Approved by two reviewers, the change spans five files with 206 additions and 37 deletions, successfully integrating the updated content.
71%
#1558296 snappy build-apps broken link to devel ref page snapcraft (launchpad) closed Fixed a broken link on the Snappy build-apps documentation page. The incorrect reference in the Strip section was corrected, resolving the report.
70%