← Back to issue list

Errors should have links to our documentation

View original Github issue

Metadata

Project
rockcraft
Number
#591
Type
issue
State
open
Author
sergiusens
Labels
Created
Updated
Closed

Current evaluation

Feature request to add documentation links to rockcraft error messages. Open 803 days, no labels, only an auto-generated Jira sync comment (CRAFT-3039); no maintainer triage or code changes addressing it.

Suggested action: needs triage

Reason: The issue has no labels, no assignee, and the only comment is the 2024-06-19 auto-generated Jira sync (CRAFT-3039) — no maintainer has assessed or prioritized it in ~2.2 years. It is not safe to close as stale because the underlying request (error messages linking to docs) is still applicable: rockcraft/application.py defines docs_url but a grep of rockcraft/ shows no error messages embedding documentation links, and no commit references this issue. A maintainer should decide whether to scope it (which errors, which doc pages) or close it as superseded.

Impact: 40 Quick Win: 22.0 Staleness: 80 Complexity: 45 Confidence: 65 Support Request: 10

Issue body

### Bug Description Most issues are not linking back to documentation ### To Reproduce . ### Environment . ### rockcraft.yaml ```shell . ``` ### Relevant log output ```shell . ```

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 40
Quick Win: 22.0
Staleness: 80
Complexity: 45
Confidence: 65
Support Request: 10
needs triage Feature request to add documentation links to rockcraft error messages. Open 803 days, no labels, only an auto-generated Jira sync comment (CRAFT-3039); no maintainer triage or code changes addressing it.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 25
Confidence: 75
Support Request: 10
needs triage Feature request to add documentation links to error messages. Unlabeled, unassigned, and inactive for over a year with no maintainer discussion.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 10
Confidence: 85
Support Request: 5
close stale Feature request to add documentation links to error messages. Untriaged, inactive for over two years, with only an automated Jira sync comment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 30
Confidence: 75
Support Request: 10
close stale Feature request to embed documentation links in error messages. Open for over two years with no maintainer labels, substantive discussion, or implementation progress.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 80
Support Request: 10
needs triage Add documentation links to error messages to improve user guidance. Currently unlabelled and inactive for over 300 days, awaiting triage and assignment. Synced to internal Jira ticket CRAFT-3039.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1051 docs: TYPE YOUR QUESTION HERE rockcraft closed Broken documentation link fixed. Contributor reported a 404 redirect for Rockcraft docs. Maintainer updated the URL to the correct stable path and closed the issue.
73%