feat: split the docs url into base and slug
Metadata
Current evaluation
Merged documentation URL refactor: CraftError now stores a topic slug while Emitter combines it with the configured docs base URL. Implemented in commit 2faeeb7 (#257).
Resolution: closed resolved
Reason: PR #257 was approved and merged into the project, resolving the request. Commit 2faeeb7 records the implementation, and the changelog lists support for a CraftError doc slug in version 2.6.0.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This commit provides a way to separate the base url for the project's docs and the slug for a specific topic. In particular, this is useful when raising a CraftError so that it holds just the slug of the user documentation for that issue, which is then combined by the Emitter into a full url when reporting the error to the user.
- [ ] Have you followed the guidelines for contributing?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox`?
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged documentation URL refactor: CraftError now stores a topic slug while Emitter combines it with the configured docs base URL. Implemented in commit 2faeeb7 (#257). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged the documentation URL refactor, separating the base URL from a topic slug so CraftError stores a slug and the Emitter assembles the full user-documentation URL. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged. Splits documentation URLs into base and slug components to improve error reporting. Approved by two reviewers, passed CI checks, and modified three files (+71/-3). |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #361 feat: docs url composition for parts | craft-application | merged | Merged craft-application#361 as 7fff65bd, composing documentation URLs from the app's docs root and Craft Parts error slugs. | |
| #758 feat: add docs slug to build exception | craft-parts | merged | Merged #758 at cb79f762, adding documentation slugs to build exceptions so errors can link to plugin documentation. | |
| #757 feat: add docs slug to build exception | craft-parts | closed | Superseded by merged PR canonical/craft-parts#758 (commit cb79f762), adding documentation slugs to build errors; released in craft-parts 1.33.0. | |
| #380 feat: render versions in doc urls | craft-application | merged | Merged in #380 via commit 600cec0e, adding versioned documentation URL rendering and version-aware Emitter links; fixes #368. |