← Back to issue list

Docs: In CLI messages, compose URLs with app's minor version

View original Github issue

Metadata

Project
craft-application
Number
#960
Type
issue
State
open
Author
medubelko
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed
—

Current evaluation

Maintainer-filed, triaged request to make render_doc_url in craft_application/util/docs.py substitute the app's minor version (not major) in RTD doc URLs, matching the planned switch to minor-only Read the Docs publishing. Still unimplemented.

Suggested action: keep open

Reason: The issue is explicitly labeled 'Status: Triaged' and 'Type: Documentation' by a maintainer (medubelko) and is a valid, scoped request with the exact function linked. Inspection confirms the code is unchanged: craft_application/util/docs.py still defaults to `major_only: bool = True` and does `version, *_ = version.split(".")`, and tests/unit/util/test_docs.py still asserts the old behavior (e.g. "2.4.6" -> "/2/"). The only commit in the file's history is 209a1367 'fix: trim documentation urls to major number (#1140)', which pushed in the opposite direction, so no resolving commit exists and the issue should stay open pending the minor-version change (mirrored as CRAFT-4912).

Evaluated by: mr-cal-bot

Impact: 35 Quick Win: 22 Complexity: 25 Confidence: 88 Actionability: 82

Issue body

## Background With `render_doc_url`, the version in doc URLs takes into account the patch version: https://github.com/canonical/craft-application/blob/fb5998d97b1cccd068843615047de9c75aeb1cc4/craft_application/util/docs.py When we move to minor-only RTD versions, these paths won't be available anymore. ## Request In alignment with our near-term plans of only publishing docs as minor versions, this function should substitute the minor version of the built app.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 35
Quick Win: 22
Complexity: 25
Confidence: 88
Actionability: 82
keep open Maintainer-filed, triaged request to make render_doc_url in craft_application/util/docs.py substitute the app's minor version (not major) in RTD doc URLs, matching the planned switch to minor-only Read the Docs publishing. Still unimplemented.
qwen/qwen3.6-35b-a3b
Impact: 40
Quick Win: 22
Complexity: 20
Confidence: 75
Actionability: 70
keep open Feature request to change render_doc_url to use minor version instead of major version for doc URLs, aligning with plans to publish docs as minor versions only.
qwen/qwen3.8-27b
Impact: 40
Quick Win: 28
Staleness: 70
Complexity: 30
Confidence: 55
Support Request: 10
needs triage Docs: In CLI messages, compose URLs with app's minor version
qwen/qwen3.6-35b-a3b
Staleness: 75
Complexity: 20
Confidence: 90
Support Request: 0
keep open Update render_doc_url to use minor versions instead of patch versions for documentation URLs, aligning with plans to publish docs as minor-only releases. Currently triaged and awaiting implementation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 15
Confidence: 85
Support Request: 5
keep open Update render_doc_url to use minor versions for documentation links instead of patch versions, aligning with RTD publishing plans. Currently triaged and awaiting implementation.

Update history

No update history recorded yet.

Related work

  • Related To: craft-application#1140 (confidence 70%)

    Commit 209a1367 in craft_application/util/docs.py history is 'fix: trim documentation urls to major number (#1140)', which introduced the major-only behavior this issue asks to reverse.

Related issues

No related issues found above the similarity threshold.