← Back to issue list

Smarter docs URL handling

View original Github issue

Metadata

Project
craft-application
Number
#301
Type
issue
State
open
Author
lengau
Labels
—
Created
Updated
Closed
—

Current evaluation

Automatic documentation URL composition from an error's doc_slug and the application's versioned docs base is implemented in the current code, despite #301 remaining open.

Suggested action: close resolved

Reason: At inspected commit 7a3a66a34d19b83ce51da485cbd7ed4b17ff29f0, craft_application/application.py configures craft-cli with docs_base_url=self.app.versioned_docs_url, and current craft-cli code appends error.doc_slug to that base while letting an explicit docs_url take precedence. This directly implements the requested behavior without applications catching and reraising library errors.

Evaluated by: mr-cal-bot

Impact: 50 Quick Win: 32 Complexity: 35 Confidence: 97 Actionability: 98

Issue body

### What needs to get done If the docs URL is a slug or something, match it to the application's docs and put that in. This will probably initially need to be a spike ### Why it needs to get done To let libraries raise exceptions without the application having to catch and reraise them with a docs URL (Suggested by @sergiusens )

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 50
Quick Win: 32
Complexity: 35
Confidence: 97
Actionability: 98
close resolved Automatic documentation URL composition from an error's doc_slug and the application's versioned docs base is implemented in the current code, despite #301 remaining open.
qwen/qwen3.6-35b-a3b
Impact: 70
Quick Win: 25
Complexity: 40
Confidence: 80
Actionability: 60
keep open Feature request to automatically compose full docs URLs from doc_slugs in library exceptions using the application's docs_url base.
qwen/qwen3.8-27b
Impact: 45
Quick Win: 27
Staleness: 55
Complexity: 40
Confidence: 55
Support Request: 10
needs triage Feature request to make docs URL handling smarter: when an error carries a docs slug, match it against the application's docs base URL so libraries can raise exceptions without the app catching/reraising them with a full docs URL. Tracked internally as CRAFT-2704; no maintainer response yet.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 40
Confidence: 75
Support Request: 10
needs triage Feature request to automatically resolve documentation slugs to full URLs, allowing libraries to raise exceptions with embedded docs links. Currently untriaged and inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 80
Complexity: 50
Confidence: 75
Support Request: 10
needs triage Feature request to automatically resolve documentation slugs to full URLs for library exceptions. Currently unlabelled, inactive for over a year, and lacks maintainer assessment.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.