feat: split the docs url into base and slug
Metadata
Current evaluation
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).
Suggested action: —
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 |
|---|---|---|---|---|
| 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). | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged changes to split documentation URLs into base and slug components. This allows CraftError to store only the slug, enabling the Emitter to construct the full URL during error reporting. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #634 feat: use versioned form of doc urls | rockcraft | merged | Merged. Updates documentation URLs in error messages and rockcraft init templates to use versioned paths. Approved by two reviewers, passed CI, and modified eight files. | |
| #361 feat: docs url composition for parts | craft-application | merged | Merged after resolving a dependency on the craft parts PR. Implements documentation URL composition for parts, emitting errors with the documentation slug when a root is set. Approved by one reviewer, adding 84 lines and removing 3 across four files. | |
| #758 feat: add docs slug to build exception | craft-parts | merged | Merged a feature pull request adding a docs slug to build exceptions. The change modified four files with 101 additions and 8 deletions, received reviewer approval, and was successfully integrated into the codebase. | |
| #583 docs: declare slug in config | starbase | merged | Merged a documentation update declaring the slug in the config to configure the sphinx-notfound-page extension. Approved by a reviewer, passed all CI checks, and modified one file to enable custom 404 page routing. | |
| #1333 feat: merge migration branch into main | rockcraft | merged | Merged the URL migration branch into main after resolving the migration blocker. Approved by one reviewer, modifying 2 files (+47/-5). CI checks passed prior to merge. | |
| #557 feat: add documentation link in help messages | craft-application | merged | Merged. Adds documentation links to general and command help messages. Approved by two reviewers, passed CI, and modified six files. Formatting adjustments resolved linter warnings. | |
| #603 feat: add doc_slug to init | rockcraft | merged | Merged after two approvals and CI. Adds doc_slug to init for reference documentation messages, starting with flask-framework. Modified 3 files with 72 additions and 42 deletions. | |
| #1302 docs: rewrite some redirects | craft-parts | merged | Merged documentation rewrite correcting several redirects to resolve recurring lint CI failures. Approved by two reviewers, passed all CI checks, and modified four files with minimal changes. | |
| #1075 fix: remove .html extension from doc slug | craft-parts | merged | Merged changes removing the .html extension from Read the Docs slugs. Approved by two reviewers, passed CI checks, and updated three files to streamline documentation URLs without impacting downstream consumers. | |
| #605 fix: 404 docs page | rockcraft | merged | Merged to fix a 404 error on the documentation page. Approved by one reviewer, passed CI checks, and modified a single file to restore the broken link. |