Create a reference page for the charm plugin
Metadata
Current evaluation
A maintainer-created documentation task remains open: add a standalone charm plugin reference page using uv as the template and replace the inline plugin details with a link.
Suggested action: keep open
Reason: The current tree still documents the charm plugin inline in docs/reference/files/charmcraft-yaml-file.rst, while docs/reference/plugins/index.rst lists the other supported plugins but omits charm. The issue explicitly identifies the uv page as a template and the inline section as the content to move, so the work is clearly scoped and ready; the only comment is an automated Jira notification.
Evaluated by: mr-cal-bot
Impact:
42
Quick Win:
29
Complexity:
24
Confidence:
96
Actionability:
91
Issue body
### What needs to get done
Create a reference page using the same template as the other plugin pages (e.g. [uv plugin](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/reference/plugins/uv_plugin/)) for the charm plugin.
The hidden charm plugin piece under https://canonical-charmcraft.readthedocs-hosted.com/en/stable/reference/files/charmcraft-yaml-file/#parts can be used for this and replaced with a link to this reference page.
### Why it needs to get done
This documentation is in a bad spot.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
42
Quick Win:
29
Complexity:
24
Confidence:
96
Actionability:
91
|
keep open | A maintainer-created documentation task remains open: add a standalone charm plugin reference page using uv as the template and replace the inline plugin details with a link. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
19
Complexity:
20
Confidence:
80
Actionability:
80
|
needs triage | Documentation task to create a reference page for the charm plugin using the uv_plugin template, and replace the hidden charm plugin section in charmcraft-yaml-file.rst with a link to the new page. | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
24
Staleness:
70
Complexity:
20
Confidence:
75
Support Request:
0
|
keep open | Documentation task to create a reference page for the charm plugin, mirroring the uv plugin page template. Unaddressed; no charm_plugin.rst exists in docs/reference/plugins/. Project is migrating users toward the uv plugin, which may reduce priority. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
15
Confidence:
80
Support Request:
10
|
needs triage | Request to create a dedicated reference documentation page for the charm plugin, replacing the current embedded section. No maintainer labels or active discussion present. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
90
Complexity:
15
Confidence:
80
Support Request:
0
|
needs triage | Unlabelled documentation task to create a reference page for the charm plugin, inactive for over a year with no maintainer response or labels. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
90
Complexity:
15
Confidence:
90
Support Request:
5
|
close stale | Request to create a dedicated reference documentation page for the charm plugin, replacing the current embedded section. The issue has been inactive for over 10 months with no maintainer response or progress. |
Update history
No update history recorded yet.
Related work
-
Related To:
charmcraft#2094
(confidence 100%)
Parallel documentation task to create a reference page for the reactive plugin.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2094 Create a reference page for the reactive plugin | charmcraft | open | Reactive plugin remains registered, but has no dedicated reference page or plugin-index entry; its details are still buried in the charmcraft.yaml parts documentation. |