← Back to issue list

Redo in-page links for: Manage channels, Manage Charmcraft, and Manage charms in How to guides

View original Github issue

Metadata

Project
charmcraft
Number
#2553
Type
pull request
State
open
Author
activus-d
Labels
—
Created
Updated
Closed
—

Current evaluation

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.

Suggested action: needs review

Reason: The reviewer explicitly handed off to lengau — medubelko commented '@lengau Ready for your review' after activus-d replied 'I've implemented your feedback' — so the single unresolved round of feedback is addressed and the review status is 'approved'. It is not superseded: git history shows commits 96c6342e (#2575) and 5f3d7908 (#2601) touched only sibling guides (manage-extensions, manage-tracks, manage-revisions, manage-charmhub-user), and ~30 'See more:' block refs still remain in main in these three files. The practical obstacle is drift, not obsolescence: manage-charms.rst has since grown to 745 lines with dropdown/terminal restructuring, and #2810/#2870 reworked the exact terminal blocks this diff edits, so actionability is capped at 45 pending a rebase and resolution of the 14 outstanding comments.

Evaluated by: mr-cal-bot

Impact: 22 Quick Win: 7 Complexity: 28 Confidence: 78 Actionability: 45

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. This is the `#2` in a series of PRs addressing [Open Documentation Academy issue #302](https://github.com/canonical/open-documentation-academy/issues/302). ## Docs pages convered - [Manage channels](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-channels.rst) - [Manage Charmcraft](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-charmcraft.rst) - [Manage charms](https://github.com/canonical/charmcraft/blob/main/docs/howto/manage-charms.rst)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 22
Quick Win: 7
Complexity: 28
Confidence: 78
Actionability: 45
needs review 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.
qwen/qwen3.6-35b-a3b
Impact: 10
Quick Win: 1
Complexity: 5
Confidence: 70
Actionability: 15
close stale Documentation PR fixing in-page links in three how-to guides. Approved by 1 reviewer but has 14 unresolved review comments. Inactive for 223 days.
qwen/qwen3.8-27b
Impact: 15
Quick Win: 13
Staleness: 78
Complexity: 15
Confidence: 68
close stale 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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 55
Complexity: 15
Confidence: 75
needs review Fixes in-page links in three How to documentation guides by moving block references into main text. Part of an Open Documentation Academy series. Currently approved by one reviewer but has 14 unresolved comments and has been inactive for over five months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 10
Confidence: 85
needs review Updates in-page links in three How-to guides by moving single-link block references into main text. Awaiting maintainer review after contributor addressed feedback 5 months ago.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 10
Confidence: 70
close stale Fixes in-page links in three How-to guides by moving block references into main text. Part of a documentation series. Inactive for ~5 months with no maintainer response.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#2575 (confidence 92%)

    Merged (96c6342e) sibling from the same Open Documentation Academy #302 series covering other 'manage' how-to guides; git_log_path confirms it did not touch manage-channels, manage-charmcraft, or manage-charms, so no file overlap.

  • Related To: charmcraft#2601 (confidence 92%)

    Merged (5f3d7908) sibling from the same series covering manage-revisions, manage-charmhub-user, and manage-tracks; confirmed by file history that the three files in this PR were untouched.

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.
82%
#2575 docs: redo in-page links in 'manage' how-to guides charmcraft merged 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.
74%