docs: add anchors and fix a few small things
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates adding intersphinx anchors, renaming the Charmcraft guide for consistency, fixing rendering errors, and resolving linting issues following reviewer feedback. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #945 docs: update docs with extra ref anchors | craft-parts | merged | Merged documentation update adding extra reference anchors to support PR #2050. Approved by two reviewers, passed CI checks, and includes a changelog entry. | |
| #983 docs: update links | rockcraft | merged | Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures. | |
| #1001 docs: maintain how-to quadrant | rockcraft | merged | Merged following two reviewer approvals and successful CI checks. Changes reorganize the landing page, refine wording, rename sections, harmonize titles and anchors, and resolve a 12-factor intersphinx bug. Updated documentation is now live. | |
| #2741 docs: update intersphinx links | charmcraft | merged | Merged documentation update refreshing intersphinx links to reflect recent domain migrations. Approved by one reviewer, passed all CI checks, and applied minimal changes across a single file. | |
| #1037 docs: Add targets for intersphinx linking | rockcraft | merged | Merged documentation update adding intersphinx targets to 12-factor sections. Approved by two reviewers and passed CI checks despite a failing snap-tests job. Changes span eight files with thirty-two additions. | |
| #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. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, modifying two files with 45 additions and 36 deletions. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged documentation update to adopt canonical-sphinx and remove unused extensions. Approved by two reviewers, passed CI, and modified four files (+30/-83 lines). | |
| #551 docs: resolve `docs-lint` issues | starbase | merged | Merged after resolving documentation linting issues. Excluded docs/_dev/ from Sphinx linting and updated link checker timeout. Passed all CI checks, received approval, and was successfully integrated. | |
| #2489 docs: add targets to 12-factor sections | charmcraft | merged | Merged documentation update adding intersphinx targets to 12-factor sections. Approved by two reviewers, the change adds 93 lines across 10 files to improve cross-referencing. |