← Back to issue list

Reorganise sample charm documentation to include the most common keys at the top.

View original Github issue

Metadata

Project
charmcraft
Number
#2643
Type
issue
State
open
Author
lengau
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed

Current evaluation

Documentation improvement: reorganise sample charm YAML and reference docs so required/common keys (name, base, parts) appear first instead of alphabetically. Triaged by maintainer, no implementation yet; sample file still alphabetical.

Suggested action: keep open

Reason: Labelled Status: Triaged by maintainer lengau, confirming it is a recognised documentation improvement. The sample file docs/reference/files/charmcraft-sample-charm.yaml still lists keys alphabetically (actions, analysis, assumes, base, build-base, charm-libs, … name, parts) with required keys like name and parts buried mid-file, so the request remains unaddressed and relevant. No evidence of a fix in recent commits touching that path.

Impact: 20 Quick Win: 17.0 Staleness: 55 Complexity: 15 Confidence: 70 Support Request: 0

Issue body

### Check existing issues - [x] I've verified that this request isn't described by any existing issues. ### Request See: https://github.com/canonical/charmcraft/pull/2632/changes#r3030066362 Reorganise the sample charm so required keys (name, base, parts, etc.) are at the top. Probably also reorganise the documentation to match. ### Document location https://documentation.ubuntu.com/charmcraft/stable/reference/files/charmcraft-yaml-file/

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 20
Quick Win: 17.0
Staleness: 55
Complexity: 15
Confidence: 70
Support Request: 0
keep open Documentation improvement: reorganise sample charm YAML and reference docs so required/common keys (name, base, parts) appear first instead of alphabetically. Triaged by maintainer, no implementation yet; sample file still alphabetical.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 15
Confidence: 85
Support Request: 0
keep open Documentation request to reorder sample charm YAML keys, placing required fields like name and base at the top. Triaged and awaiting implementation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 60
Complexity: 15
Confidence: 85
Support Request: 0
keep open Request to reorder sample charm documentation so required keys like name, base, and parts appear first, aligning with reference docs. Currently triaged but inactive for 91 days.
qwen3.6-35b-a3b-mtp-q6
Staleness: 55
Complexity: 10
Confidence: 85
Support Request: 0
keep open Documentation task to reorder sample charm YAML keys to place required fields at the top, aligning with PR feedback. Currently triaged but inactive for 88 days.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 15
Confidence: 85
Support Request: 0
keep open Reorganize sample charm documentation to place required keys at the top. Status is triaged with an internal Jira ticket created, awaiting assignment and implementation.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.