← 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
2026-04-07 17:29:52+00:00
Updated
2026-04-07 17:30:13+00:00
Closed

Current evaluation

Reorganize sample charm documentation to place common and required keys at the top, currently triaged and awaiting implementation.

Suggested action: keep open

Reason: The issue is already triaged and clearly scoped as a documentation improvement. While inactive for ~2 months, it remains relevant and valid, so it should be kept open for future implementation rather than closed or re-triaged.

Staleness: 25 Complexity: 15 Confidence: 90 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
2026-06-15 12:03:17.849679+00:00 qwen3.6-35b-a3b-mtp-q6
Staleness: 25
Complexity: 15
Confidence: 90
Support Request: 0
keep open Reorganize sample charm documentation to place common and required keys at the top, currently triaged and awaiting implementation.
2026-06-15 12:00:51.840867+00:00 pending