← Back to issue list

docs(debug): add the step to install snappy-debug

View original Github issue

Metadata

Project
snapcraft
Number
#6457
Type
pull request
State
closed
Author
wak327
Labels
—
Created
Updated
Closed

Current evaluation

PR #6457 was closed unmerged without review; the missing snappy-debug installation instructions did not land, and issue #5726 remains open.

Resolution: closed stale

Reason: PR #6457 was closed without merge or a maintainer explanation after receiving no review. Commit e81c28a30 (#6165) had already fixed only the broken-link portion; the installation step remains unresolved in #5726.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The steps for finding missing interfaces with `snappy-debug` started with running it, without mentioning that it's a snap that has to be installed first. This adds the install step, and a meta description for the page. The issue also mentions that the "Debugging snaps" link at the end of the page pointed back to the page itself. That's already fixed on `main`: the section now links to the debugging guide in the snapd documentation. Fixes #5726 --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed stale PR #6457 was closed unmerged without review; the missing snappy-debug installation instructions did not land, and issue #5726 remains open.
qwen/qwen3.8-27b — closed stale PR #6457 added the missing 'install snappy-debug' step and a page meta description to docs/how-to/debugging/debug-a-snap.rst, targeting issue #5726. Closed without merge; no maintainer review was completed and the linked issue remains open.
stealth/space-bunny-alpha
Impact: 28
Quick Win: 21
Complexity: 5
Confidence: 88
Actionability: 80
needs review Adds the missing 'install snappy-debug' step and a page meta description to docs/how-to/debugging/debug-a-snap.rst (+13/-4, one file). Addresses snapcraft#5726; CI green, awaiting maintainer review.

Update history

Date Change
closed
created

Related work

  • Related To: snapcraft#5726 (confidence 100%)

    The open issue targeted by the unmerged documentation change.

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

    Commit e81c28a30 fixed the page's broken Debugging snaps link, but not the missing install step.

Related issues

Issue Project State Summary Similarity
#5726 docs: [debug a snap] mention that snappy-debug is a snap, and fix broken 'Debugging snaps' link snapcraft 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.
77%