docs: add charm docs exemplars links
Metadata
Current evaluation
Merged #2253 as commit 982a6c16, adding links to small and large charm documentation exemplars.
Resolution: closed resolved
Reason: The documentation update merged into main as commit 982a6c16 after two approvals. It improved charm documentation guidance with small- and large-charm exemplars.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Improve charm docs guidance to include smaller/bigger charm docs.
Add links to the charm docs exemplars.
This is a part of the [Epic](https://warthogs.atlassian.net/browse/DOCPR-948) to Standardise charm documentation by creating exemplars of good.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #2253 as commit 982a6c16, adding links to small and large charm documentation exemplars. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as 982a6c16, adding exemplar links for smaller and larger charms to improve charm documentation guidance. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #2253 (982a6c16), adding links to smaller- and larger-charm documentation exemplars to improve charm documentation guidance. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged charmcraft PR #2253 via commit 982a6c16, adding smaller- and larger-charm documentation exemplars to improve charm docs guidance. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after approval and CI checks. Added links to charm documentation exemplars to improve guidance. Updated one file with 34 additions and 5 deletions as part of a documentation standardization initiative. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding links to charm documentation exemplars to improve guidance. Authored by external contributor izmalk as part of the DOCPR-948 standardization epic. Approved and merged after review. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2262 docs: hotfix for links syntax for charm docs examples | charmcraft | merged | Merged PR #2262 as commit 675e5e7e, fixing links in the Manage charms docs and adding a Charmhub Discourse link. | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Docs PR #2748 merged (commit 0389aeb4): rewrote charm naming guidance in the charmcraft.yaml reference and manage-charms how-to, replacing inline best-practice notes with links to the Ops docs. Fixes #2582; relied on canonical/operator#2610. | |
| #161 Add a link to the online documentation in the help summary | charmcraft | closed | Added the Charmhub documentation link to Charmcraft’s help output in merged PR #188 (ffc44697). | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged PR #471 via commit e0b18661, documenting the charm part in the configuration schema for CRAFT-356. | |
| #2129 docs: add additional anchors on the "manage charms" page for linking to | charmcraft | closed | Closed as a duplicate of #2128, which was merged as commit e880b4bd and added the requested intersphinx anchors to the Manage charms documentation. | |
| #88 docs: add docstrings for the charm build planner | craft-platforms | merged | Merged PR #88, commit 6becdf6, documenting the charm build planner and expanding the README; it fixes #75. | |
| #2844 docs: add how-to guide for packing charms in monorepos | charmcraft | merged | Merged into main. PR #2844 added docs/howto/pack-a-charm-in-a-monorepo.rst, linked it from docs/howto/index.rst, updated Charmcraft 4.5 release notes, and added 'monorepos?' to the wordlist, fixing CHARMCRAFT-721. | |
| #2299 docs: fix formatting issues | charmcraft | merged | Merged docs formatting fixes for local documentation builds in charmcraft#2299 via commit 5ffb80fe; two files changed (+3/-1). | |
| #2744 docs: adding the icon part to a charm is too hidden away | charmcraft | closed | Docs gap closed by merged PR #2711 (commit 037c5b41): the Manage icons how-to now documents packaging icon.svg via a dump part, and the icon.svg reference page links to it. |