← Back to issue list

docs: add related links section to docs homepage

View original Github issue

Metadata

Project
charmcraft
Number
#2464
Type
pull request
State
merged
Author
james-garner-canonical
Labels
Created
Updated
Closed

Current evaluation

Merged PR adding a relatedlinks section to the Charmcraft documentation homepage. Initial CI failures were resolved by rebasing after PR #2466 fixed a line length constraint. Approved by two reviewers and successfully merged.

Suggested action:

No scores available.

Issue body

This PR adds `relatedlinks` metadata to the Charmcraft documentation site homepage. [**Preview build**](https://canonical-ubuntu-documentation-library--2464.com.readthedocs.build/charmcraft/2464/) This uses the related links extension included in `canonical`'s Sphinx extensions. I've used the same list that we use for [ops](https://documentation.ubuntu.com/ops/latest/) and [charmlibs](https://documentation.ubuntu.com/charmlibs/), with the addition of Craft Parts. Perhaps there are more craft specific links that could be included, or maybe some of the currently included links aren't related enough (Jubilant? Pebble?). The list is currently (manually) sorted alphabetically, but this can be changed too.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged PR adding a relatedlinks section to the Charmcraft documentation homepage. Initial CI failures were resolved by rebasing after PR #2466 fixed a line length constraint. Approved by two reviewers and successfully merged.
qwen3.6-35b-a3b-mtp-q6 Merged after adding related links metadata to the Charmcraft documentation homepage via the canonical Sphinx extension. Required rebasing following PR #2466, which resolved line length constraints. Checks passed and the update was integrated.
qwen3.6-35b-a3b-mtp-q6 Merged. Added a related links section to the Charmcraft documentation homepage via a Sphinx extension. The branch was rebased after PR #2466 resolved a line length constraint, passing all documentation checks.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
75%
#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.
74%
#291 docs: fix linkcheck issues with documentation craft-store merged Merged after approval and passing all CI checks. Resolved documentation linkcheck issues by fixing broken links, addressing issue #290. Changes modified two files with five additions and two deletions.
72%
#1104 docs: update links craft-parts merged Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures.
72%
#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.
72%
#1063 docs: fix a missing link rockcraft merged Merged a documentation fix adding a missing hyperlink. Approved by four reviewers with a single-line change. The PR was merged despite one failing CI check (snap-tests), as the documentation-only update was deemed low-risk.
71%
#471 config: add charm part to documentation (CRAFT-356) charmcraft merged Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356.
71%
#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.
71%
#872 docs: add anchors to support charmcraft documentation craft-parts merged Merged. Added documentation anchors to Python and Poetry pages for Charmcraft support. Approved by two reviewers with passing CI and zero unresolved comments.
71%
#2080 docs: add platforms reference and how-to charmcraft merged Merged documentation updates for Charmcraft platforms, bases, and architectures, covering multi-base support. Approved by three reviewers, passed CI checks, and resolved issue #2009.
70%