← Back to issue list

docs: add targets to 12-factor sections

View original Github issue

Metadata

Project
charmcraft
Number
#2489
Type
pull request
State
merged
Author
erinecon
Labels
Created
Updated
Closed

Current evaluation

Merged documentation update adding intersphinx targets to 12-factor sections. Approved by two reviewers, the change adds 93 lines across 10 files to improve cross-referencing.

Suggested action:

No scores available.

Issue body

### Overview Add new targets to 12-factor sections of the documentation. ### Rationale We're introducing [intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) into the [12-factor support RTD project](https://canonical-12-factor-app-support.readthedocs-hosted.com/latest/), and while I was converting the Charmcraft links, I spotted a few sections that were missing targets. ### Checks I ran `make lint-docs` locally to verify that the documentation lint tests passed.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged documentation update adding intersphinx targets to 12-factor sections. Approved by two reviewers, the change adds 93 lines across 10 files to improve cross-referencing.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update adding missing targets to 12-factor sections to support intersphinx integration. Changes passed local lint checks and were accepted without review comments.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update adding missing targets to 12-factor sections. The change enables intersphinx integration for the 12-factor support RTD project and passed local lint checks.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1037 docs: Add targets for intersphinx linking rockcraft merged Merged documentation update adding intersphinx targets to 12-factor sections. Approved by two reviewers and passed CI checks despite a failing snap-tests job. Changes span eight files with thirty-two additions.
91%
#1274 docs: update intersphinx paths rockcraft merged Merged documentation update correcting intersphinx mapping paths for the 12-factor docs after a URL migration and RTD project deletion. Approved by two reviewers, passed all CI checks, and modified one file.
79%
#1253 docs: Incorporate user feedback in the 12-factor reference pages rockcraft merged Merged documentation updates to the 12-factor reference pages. Incorporates UXR feedback by improving headers, clarifying parts snippets and file inclusion rules, adding links and captions, and fixing acronyms. Approved and passed CI.
75%
#2219 Docs: Add 12-factor how-to sections for integrations charmcraft merged Merged documentation update adding three sections on integrating web app charms with databases, ingress, and observability. Approved by three reviewers, the change modifies one file with 50 additions and 2 deletions.
74%
#956 docs: Incorporate UX feedback into 12-factor tutorials rockcraft merged Merged documentation updates to 12-factor tutorials incorporating UX feedback. Corrects browser instructions, reorganizes commands, adds experimental extension variables, updates next steps, and adds intersphinx links. Approved by two reviewers and passed CI.
74%
#877 docs: Reorganize 12-factor how-to guides rockcraft merged Merged documentation reorganization splitting the 12-factor how-to guide into initialization, configuration, and usage files under a new directory. Updated index and added redirect. Approved by two reviewers and merged after passing doc lint.
74%
#2193 Docs: Maintenance work on 12-factor tutorials charmcraft merged Merged documentation maintenance for 12-factor tutorials. Updates rename files for shorter URLs, fix code highlighting, revise instructions, and standardize terminology for consistency and accessibility. Approved by two reviewers.
74%
#2368 docs: Update 12-factor initialization how-to guide charmcraft merged Merged documentation update consolidating the 12-factor initialization guide into the main how-to page, removing dedicated sections, and updating redirects. Approved by reviewers with CI lint errors dismissed as unrelated to the docs.
74%
#2220 docs: 12-factor tutorial maintenance charmcraft merged Merged documentation maintenance for 12-factor tutorials. Changes include numbered task lists, tildes for root directories, explicit paths in captions, and renaming visitors_app.py to app.py. Approved by two reviewers with passing CI.
74%
#2128 docs: add anchors and fix a few small things charmcraft merged Merged documentation updates adding intersphinx anchors, renaming sections for consistency, fixing rendering issues, and resolving linting errors. Approved by reviewers and integrated after manual fixes.
73%