canonical / canonical/craft-application

Smarter docs URL handling

Open
#301 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
14
Forks
29
Avg merge
2d 3h
Merged PRs (30d)
12

Description

### 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 )

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named. Start by tracing how exceptions and documentation URLs are currently handled, then clarify how a slug should map to the application's docs and what the spike must establish. Done means an agreed approach for allowing libraries to provide docs URLs without application-level catch-and-reraise handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.