docs: redo in-page links in 'manage' how-to guides
Metadata
Current evaluation
Docs PR merged as commit 96c6342e: reworked in-page links (moving single-link block references into prose) and added intro sentences across 5 manage how-to guides; manage-parts skipped for TBA placeholders.
Resolution: closed resolved
Reason: PR #2575 was approved by two reviewers and merged into main as commit 96c6342e ("docs: redo in-page links in 'manage' how-to guides"), touching manage-extensions, manage-icons, manage-libraries, manage-names and manage-resources.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This PR fixes the in-page links for some pages in the How to guides section of the documentation by moving single-link block references into the main text. It also adds introductory sentences to some sections to make the docs more user friendly.
This is the `#3` in a series of PRs addressing [Open Documentation Academy issue #302](https://github.com/canonical/open-documentation-academy/issues/302).
## Docs pages covered
* [Manage extensions](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-extensions.rst)
* [Manage icons](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-icons.rst)
* [Manage libraries](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-libraries.rst)
* [Manage names](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-names.rst)
* [Manage resources](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-resources.rst)
## Note
Skipped the [Manage parts](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-parts.rst) docs as it currently contains `TBA (To Be Added)` placeholders.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Docs PR merged as commit 96c6342e: reworked in-page links (moving single-link block references into prose) and added intro sentences across 5 manage how-to guides; manage-parts skipped for TBA placeholders. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs PR #2575 by activus-d was approved and merged (commit 96c6342e), reworking in-page links and adding intro sentences in 5 'manage' how-to guides. Part of an Open Documentation Academy series; manage-parts skipped as TBA. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in charmcraft#2575 (commit 96c6342e), rewriting in-page links and adding introductory text across five manage how-to guides; approved by two reviewers. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update that restructured in-page links across five manage how-to guides by integrating block references into the main text. Added introductory sentences to improve readability. Approved by reviewers and successfully merged. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates restructuring in-page links and adding introductory sentences to five manage how-to guides. Resolves part three of Open Documentation Academy issue #302. The manage parts guide was skipped. |
Update history
No update history recorded yet.
Related work
-
Related To:
charmcraft#2534
(confidence 80%)
Merged companion PR reformatting in-page links in tutorials; #2534 was #1 of the same Open Documentation Academy #302 series, #2575 is #3.
-
Superseded By:
charmcraft#2594
(confidence 40%)
Later docs build update (canonical starter pack 1.5) changed the same howto RST files, but did not negate this PR's content.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #2534 docs: reformat in-page links in tutorials | charmcraft | merged | Merged tutorial documentation cleanup in PR #2534 (commit 04cc6d5d), moving single-link block references into prose as part of Open Documentation Academy #302. | |
| #2553 Redo in-page links for: Manage channels, Manage Charmcraft, and Manage charms in How to guides | charmcraft | open | Rewrites in-page 'See more:' block refs into main text for manage-channels, manage-charmcraft, and manage-charms how-to guides. Approved, 14 unresolved comments, idle 237 days; the three files have since been heavily reworked, so a rebase is likely needed. | |
| #2684 docs: remove 'Manage parts' | charmcraft | merged | Merged PR #2684 as commit 84818107, removing the placeholder-only "Manage parts" how-to guide and related references across four files. |