docs: reformat in-page links in tutorials
Metadata
Current evaluation
Merged tutorial documentation cleanup in PR #2534 (commit 04cc6d5d), moving single-link block references into prose as part of Open Documentation Academy #302.
Resolution: closed resolved
Reason: PR #2534 was approved and merged as commit 04cc6d5d, resolving the tutorial in-page-link formatting problem.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This PR fixes the in-page links in the **Tutorial** section of the documentation by moving single-link block references into the main text.
This is the first in a series of PRs addressing [Open Documentation Academy issue #302](https://github.com/canonical/open-documentation-academy/issues/302).
It's intended to confirm that the chosen approach aligns with the preferred solution. Feedback from this PR will be taken into account in subsequent PRs related to the same issue.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged tutorial documentation cleanup in PR #2534 (commit 04cc6d5d), moving single-link block references into prose as part of Open Documentation Academy #302. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #2534, reformatting tutorial in-page links by moving single-link block references into the main text; the first PR addressing Open Documentation Academy #302. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation changes that reformat in-page links in tutorials by moving single-link block references into the main text. This update validates the approach for a broader series of documentation improvements. |
Update history
No update history recorded yet.
Related work
-
Related To:
open-documentation-academy#302
(confidence 99%)
The PR is the first in a series addressing this documentation academy issue.
-
Related To:
canonical/charmcraft#2575
(confidence 98%)
Follow-up PR applying the same in-page-link approach to manage how-to guides.
-
Related To:
canonical/charmcraft#2601
(confidence 98%)
Follow-up PR applying the same documentation-link cleanup to additional guides.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1013 docs: fix typo in tutorial index and academy link | rockcraft | merged | Merged in PR #1013 via commit 21371897, correcting the repeated tutorial number from 9 to 10 and fixing the documentation academy link. | |
| #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. | |
| #1063 docs: fix a missing link | rockcraft | merged | Merged PR #1063 fixed a missing documentation hyperlink in commit 8c4ab4a3; the one-line change was approved by four reviewers. |