docs: add anchors and fix a few small things
Metadata
Current evaluation
Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error.
Resolution: closed resolved
Reason: PR #2128 was merged into main as commit e880b4bd ('docs: add anchors and fix a few small things (#2128)'), confirmed by git log on docs/howto/manage-charmcraft.rst. The follow-up sibling PR #2129 requesting the same anchors was closed as a duplicate of this merged PR.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This PR adds a few anchors that will be used through intersphinx in the Ops docs.
The PR also changes a couple of titles and adds some content. Also fixes a weird rendering error.
Note:
- The reason I've changed "Set up Charmcraft" to "Manage Charmcraft", as it used to be, is because that's the pattern we follow everywhere in Juju-world docs, the reason being that that docs doesn't just cover setup but should also cover upgrade and uninstall. I've added some content to that effect as well.
- For charm naming best practices we should at some point enhance that note to reflect, in streamlined fashion, all the crucial bits from https://discourse.charmhub.io/t/charm-naming-guidelines/5364#naming-charms-1 (this old Discourse post can then be discarded).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charmcraft), retitled "Set up Charmcraft" to "Manage Charmcraft" with upgrade/uninstall content, and fixed a rendering error. Follow-up PR #2129 was closed as a duplicate. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged after two approvals. Added intersphinx anchors, retitled and expanded the Charmcraft management docs, and fixed a rendering error. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in PR #2128 (commit e880b4bd), adding intersphinx anchors, renaming docs sections, adding setup/upgrade/uninstall guidance, and fixing rendering and lint issues. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation updates adding intersphinx anchors, renaming sections for consistency, fixing rendering issues, and resolving linting errors. Approved by reviewers and integrated after manual fixes. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after the contributor resolved linting feedback. The update adds intersphinx anchors, updates documentation titles and content, fixes a rendering error, and standardizes Charmcraft setup instructions. |
Update history
No update history recorded yet.
Related work
-
Duplicate Of:
canonical/charmcraft#2129
(confidence 95%)
Follow-up PR by the same author requesting the same intersphinx anchors on the 'manage charms' page; closed as a duplicate of #2128, which already added them.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #872 docs: add anchors to support charmcraft documentation | craft-parts | merged | Merged anchors for the Python and Poetry documentation, enabling Charmcraft to link into the Craft Parts docs (commit 0436a75d). | |
| #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. | |
| #945 docs: update docs with extra ref anchors | craft-parts | merged | Merged PR #945 added documentation reference anchors and a changelog entry for canonical/charmcraft#2050 (commit 5a1727ee). | |
| #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. | |
| #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. | |
| #2010 docs: add, refactor, and reformat discourse docs feat. charmcraft | charmcraft | merged | Merged PR #2010 as commit a1a3d4b1, migrating Charmcraft content to RTD-ready docs, reformatting it, and separating Ops-related material. | |
| #1341 [JUJU-4554] Update the README to simplify and better align with docs | charmcraft | merged | Docs-only PR merged as commit 647a605c (#1341): rewrote Charmcraft's README (+62/-118) to a shorter intro placing Charmcraft in the Juju/Charm SDK ecosystem and linking to Charm SDK docs instead of Multipass install steps. | |
| #2135 Docs: Broken references to Juju | charmcraft | closed | Fixed by merged PR charmcraft#2136 in commit fe64df47, correcting six broken Juju documentation references across four files. | |
| #2601 docs: Redo in-page links for: Mange charm revisions, Manage the current charmhub user, and Manage tracks | charmcraft | merged | Docs-only PR merged as commit 5f3d7908: reworked in-page links (block references into main text) and added intro sentences in manage-revisions, manage-the-current-charmhub-user, and manage-tracks how-to guides; approved by 2 reviewers. | |
| #2186 docs: fix build errors | charmcraft | merged | Merged as charmcraft/charmcraft#2186 in commit 42f42bd2, fixing the targeted docs build error. Remaining transclusion problems were addressed separately in canonical/craft-parts#1021. |