docs: Redo in-page links for: Mange charm revisions, Manage the current charmhub user, and Manage tracks
Metadata
Current evaluation
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.
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 `#4` in a series of PRs addressing [Open Documentation Academy issue #302](https://github.com/canonical/open-documentation-academy/issues/302).
## Docs pages covered
* [Manage charm revisions](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-revisions.rst)
* [Manage the current Charmhub user](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-the-current-charmhub-user.rst)
* [Manage tracks](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-tracks.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 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for managing charm revisions, Charmhub user, and tracks. In-page links were integrated into main text and introductory sentences added. Reviewer feedback was implemented prior to merge. Addresses Open Documentation Academy issue #302. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates for three How-to guides, restructuring in-page links and adding introductory text. Part of Open Documentation Academy issue #302. Review feedback applied prior to merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #2575 docs: redo in-page links in 'manage' how-to guides | charmcraft | merged | 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. | |
| #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. | |
| #2453 docs: update link to public listing review process | charmcraft | merged | Merged documentation update replacing the outdated Charmhub public listing review link with current Ops instructions. Approved by two reviewers, passed CI checks, and applied to a single file. | |
| #2253 docs: add charm docs exemplars links | charmcraft | merged | 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. | |
| #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. | |
| #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. | |
| #2182 docs: add mention of `charmcraft promote` to manage-revisions.rst | charmcraft | merged | Merged documentation update adding a reference to charmcraft promote in manage-revisions.rst and fixing a broken literalinclude directive in charmcraft-yaml-file.rst. Approved by two reviewers and integrated into the codebase. | |
| #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. |