docs: redo in-page links in 'manage' how-to guides
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update fixing in-page links across five manage how-to guides by moving single-link references into the main text and adding introductory sentences. Addresses Open Documentation Academy issue #302. |
Update history
No update history recorded yet.
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 | 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. | |
| #2534 docs: reformat in-page links in tutorials | charmcraft | merged | Merged documentation changes that reformat in-page tutorial links by moving single-link block references into the main text. Approved by two reviewers, this update serves as the initial step in a series addressing Open Documentation Academy issue #302. | |
| #2553 Redo in-page links for: Manage channels, Manage Charmcraft, and Manage charms in How to guides | charmcraft | open | Docs-only PR moving single-link block references into main text for three How-to guides (Manage channels, Manage Charmcraft, Manage charms). Approved by 1 reviewer, 14 unresolved comments, inactive ~7 months; same in-page-link redo merged via #2575. | |
| #2327 docs: fix some links | charmcraft | merged | Merged a documentation update that corrected several broken links across two files. Approved by two reviewers, the changes were successfully integrated into the main branch, resolving navigation issues in the project documentation. | |
| #5440 docs: reorganise pages | snapcraft | merged | Merged after reorganizing documentation pages to improve the learning path and content chunking. Approved by two reviewers, failing integration tests were resolved, and the maintainer completed the merge. | |
| #447 docs: rename page, change order, fix markup | craft-parts | merged | Merged documentation update that renamed a page, reordered content, and corrected markup. Approved by one reviewer, passed CI checks, and modified three files with a net change of one line. | |
| #5441 docs: revise home page | snapcraft | merged | Merged documentation update revising the home page. Approved by two reviewers, rebased against a reorganized table of contents, and merged by maintainer medubelko. | |
| #1068 docs: Updating how to crafting pages to new linking method | rockcraft | merged | Merged documentation update replacing outdated craft-parts links with the new linking method. Resolves #1067, corrects build override references, and was approved before merging despite one failing CI check. | |
| #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. | |
| #288 docs: consolidate external links | rockcraft | merged | Merged documentation update consolidating external links. Approved by two reviewers, passed CI checks, and modified six files with 19 additions and 12 deletions. |