← Back to issue list

Improve article "Parts and Steps"

View original Github issue

Metadata

Project
rockcraft
Number
#628
Type
issue
State
open
Author
hd9
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

Request to clarify two ambiguous terms in the rockcraft 'Parts and Steps' reference doc: link 'craft-parts' to the Parts concept and define 'project'. Doc still contains the same generic wording; no maintainer response in 788 days.

Suggested action: needs triage

Reason: The issue has a 'Type: Documentation' label but zero maintainer comments, no assignee, and no indication of prioritization. The underlying doc (shared from craft-parts repo via include) still reads 'Parts and steps define the lifecycle of a project' with no link to the Parts explanation page, confirming the reported ambiguity persists. The request is well-scoped and actionable but has not been assessed by a maintainer.

Impact: 30 Quick Win: 22.5 Staleness: 55 Complexity: 25 Confidence: 75 Support Request: 15

Issue body

### Request type Enhancement ### What needs to get done This is a request to improve the [Parts and Steps](https://documentation.ubuntu.com/rockcraft/en/latest/reference/parts_steps/) article. The following points are not clear for a new rock developer: 1. `craft-parts` in the first phrase. Are we talking about [Parts](https://documentation.ubuntu.com/rockcraft/en/latest/explanation/parts/), or is this a new concept? 2. The word _project_ in the article is generic and is not clear in this context. The reader would not know if we’re talking about a generic software project, or if this is a concept related to rocks or rockcraft. Suggestions: 1. If `craft-parts` means [Parts](https://documentation.ubuntu.com/rockcraft/en/latest/explanation/parts/), link to it. Else, provide more information. 2. Clarify what _project_ is. Is this a term we use when building rocks? ### Documentation location https://documentation.ubuntu.com/rockcraft/en/latest/reference/parts_steps/ ### Additional information _No response_

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 22.5
Staleness: 55
Complexity: 25
Confidence: 75
Support Request: 15
needs triage Request to clarify two ambiguous terms in the rockcraft 'Parts and Steps' reference doc: link 'craft-parts' to the Parts concept and define 'project'. Doc still contains the same generic wording; no maintainer response in 788 days.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 15
Confidence: 85
Support Request: 5
needs triage Documentation enhancement request to clarify terminology like craft-parts and project in the Parts and Steps article. Currently untriaged with no maintainer comments after 222 days of inactivity.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 85
Support Request: 0
needs triage Documentation enhancement request to clarify terminology like craft-parts and project in the Parts and Steps article. Open for over two years with no maintainer response.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 90
Support Request: 10
needs triage Documentation enhancement request to clarify terminology like craft-parts and project in the Parts and Steps article. Unassigned, no maintainer comments, open for two years.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 10
Confidence: 75
Support Request: 0
needs triage Documentation enhancement request to clarify the Parts and Steps article. Suggests linking craft-parts to the Parts concept and defining project context. Open with no comments and 186 days of inactivity, awaiting triage or assignment.

Update history

No update history recorded yet.

Related work

  • Related To: craft-parts#688 (confidence 60%)

    Commit 841244bd 'feat(docs)!: rework bundling of shared docs (#688)' restructured how the shared parts_steps.rst is included into rockcraft docs, which is the file this issue targets for improvement.

Related issues

No related issues found above the similarity threshold.