← 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

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

Suggested action: needs triage

Reason: The issue is labeled 'Status: Triaged' and 'Type: Documentation', and the Jira bot created ticket CRAFT-4912, so it has been acknowledged. However, the current code (render_doc_url in craft_application/util/docs.py) trims to the MAJOR version by default (major_only=True), which does NOT match the issue's request to substitute the MINOR version (major.minor). PR #1140 'fix: trim documentation urls to major number' changed the behavior to major-only, which may have been a different decision than what this issue requested. The issue has not been explicitly closed or resolved, and there's ambiguity about whether the documentation policy is now major-only or minor-only. This needs human review to determine if the current major-only behavior satisfies the issue or if the minor-version request is still valid.

Impact: 40 Quick Win: 28.0 Staleness: 70 Complexity: 30 Confidence: 55 Support Request: 10

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
qwen/qwen3.8-27b
Impact: 40
Quick Win: 28.0
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 20
Confidence: 85
Support Request: 0
keep open Modify render_doc_url to use the app's minor version for CLI documentation links, aligning with upcoming minor-only Read the Docs publishing. Currently triaged and awaiting implementation.

Update history

No update history recorded yet.

Related work

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

    PR #1140 'fix: trim documentation urls to major number' changed render_doc_url to trim to major version by default. This is related to the issue's request but may not fully address it (issue wanted minor version, PR did major version).

  • Related To: craft-application#380 (confidence 60%)

    PR #380 'feat: render versions in doc urls' introduced the render_doc_url function that this issue is about.

Related issues

No related issues found above the similarity threshold.