docs: add charm docs exemplars links
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged an external contribution adding links to charm documentation exemplars to improve guidance. Approved by medubelko as part of the DOCPR-948 standardization epic. |
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 following approval by three reviewers. The change corrected link syntax in the Manage charms documentation and added a Charmhub Discourse link. All required CI checks passed before integration. | |
| #2748 docs: improve charm naming docs, with links to detailed guidance | charmcraft | merged | Merged documentation updates improving charm naming guidance. Changes remove outdated best practice notes, add value descriptions, link to detailed Ops documentation, and clarify the init command workflow. Approved and merged to resolve issue #2582. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356. | |
| #242 Add init documentation for a gentle introduction to the charm operator | charmcraft | merged | Merged PR adding starter docs to charmcraft init. Reviewer requested moving content to a Charmhub discourse wiki and linking it. Contributor adapted the change, and the PR was merged with the external link integrated. | |
| #2240 docs: update charm definition in security doc | charmcraft | merged | Merged documentation update revising the charm definition in the security guide. Incorporated feedback from a prior discussion, approved by two reviewers, passed CI checks, and successfully merged with minimal line changes. | |
| #2473 docs: distinguish between Charmhub-hosted libs and Python packages | charmcraft | merged | Merged documentation update distinguishing Charmhub-hosted and Python package charm libraries. Added explanatory links, removed redundant sections, and updated command help. Approved by reviewers and passed CI checks. | |
| #2601 docs: Redo in-page links for: Mange charm revisions, Manage the current charmhub user, and Manage tracks | charmcraft | merged | Merged documentation update fixing in-page links and adding introductory sentences to three how-to guides. Reviewer feedback was implemented before merge, completing a series for the Open Documentation Academy. | |
| #2464 docs: add related links section to docs homepage | charmcraft | merged | Merged PR adding a relatedlinks section to the Charmcraft documentation homepage. Initial CI failures were resolved by rebasing after PR #2466 fixed a line length constraint. Approved by two reviewers and successfully merged. | |
| #872 docs: add anchors to support charmcraft documentation | craft-parts | merged | Merged. Added documentation anchors to Python and Poetry pages for Charmcraft support. Approved by two reviewers with passing CI and zero unresolved comments. | |
| #2010 docs: add, refactor, and reformat discourse docs feat. charmcraft | charmcraft | merged | Merged documentation updates adding, refactoring, and reformatting Discourse content for Charmcraft into the ReadTheDocs project. Includes markdown to RST conversion, linter fixes, and structural improvements. Approved with noted future adjustments. |