← Back to issue list

docs: reformat in-page links in tutorials

View original Github issue

Metadata

Project
charmcraft
Number
#2534
Type
pull request
State
merged
Author
activus-d
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged documentation changes that reformat tutorial in-page links by moving single-link block references into the main text. This update addresses Open Documentation Academy issue #302 and validates the approach for subsequent related PRs.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
78%
#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.
75%
#1013 docs: fix typo in tutorial index and academy link rockcraft merged Merged documentation update correcting a repeated tutorial index number and updating an academy link. Approved by three reviewers. Changes span two files (+2/-2 lines). CI passed except snap-tests, which did not block the merge.
73%
#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.
72%