← Back to issue list

docs: declare slug in config

View original Github issue

Metadata

Project
starbase
Number
#583
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

Merged #583, adding the docs slug to Sphinx config so Canonical Sphinx can resolve the custom sphinx-notfound-page 404 route.

Resolution: closed resolved

Reason: PR #583 was merged with all reported CI checks passing. It declares the documentation slug so Canonical Sphinx can configure sphinx-notfound-page correctly.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Canonical Sphinx uses this to configure the sphinx-notfound-page extension. Live 404 page: https://documentation.ubuntu.com/starbase/oops PR build 404 page: https://canonical-ubuntu-documentation-library--583.com.readthedocs.build/starbase/583/oops --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/starbase/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [ ] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged #583, adding the docs slug to Sphinx config so Canonical Sphinx can resolve the custom sphinx-notfound-page 404 route.
stealth/space-bunny-alpha — closed resolved Merged #583, declaring the documentation slug in Sphinx config so sphinx-notfound-page resolves the correct custom 404 route; all reported CI checks passed.
qwen/qwen3.6-35b-a3b — — 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.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
needs review Configures the slug setting for the sphinx-notfound-page extension to enable custom 404 pages. Currently pending maintainer review with all CI checks passing.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Updates Canonical Sphinx config to declare the slug setting for the sphinx-notfound-page extension, standardizing 404 page URLs. Currently pending maintainer review with all CI checks passing.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Adds slug configuration to Sphinx config for the notfound-page extension to standardize 404 page styling. Currently pending maintainer review with all CI checks passing.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Adds a slug configuration for Sphinx's notfound-page extension to standardize 404 page URLs across canonical documentation. Currently pending maintainer review with all CI checks passing.

Update history

Date Change
updated
updated
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#470 docs: declare slug in config craft-cli merged Merged PR #470 added the craft-cli documentation slug to Sphinx config, enabling sphinx-notfound-page to serve Canonical's custom 404 page.
91%
#993 docs: declare slug in config craft-providers merged Merged in commit 57d57af, declaring the project slug in Sphinx config so Canonical Sphinx can configure its custom 404 page.
91%
#244 docs: declare slug in config craft-archives merged Merged PR #244 added slug = "craft-archives" to docs/conf.py so sphinx-notfound-page can configure the documentation 404 page.
89%
#1661 docs: declare slug in config craft-parts merged PR #1661 merged: added the project slug to docs/conf.py so Canonical Sphinx configures sphinx-notfound-page, restoring the custom 404 page on documentation.ubuntu.com/craft-parts.
89%
#1158 docs: declare slug in config craft-application merged Merged PR #1158 (1 file, +2/-2) declared the project slug in the Sphinx docs config so Canonical Sphinx can enable sphinx-notfound-page and serve a custom 404 page at /craft-application/oops.
89%
#207 docs: declare slug in config craft-grammar merged PR #207 merged, adding `slug` to craft-grammar's Sphinx conf.py so Canonical Sphinx enables sphinx-notfound-page; the custom 404 page now renders on live and PR builds. 2 approvals, all CI checks green.
84%
#261 docs: declare slug in config craft-platforms merged PR #261 merged as commit 390d4b3, adding `slug = "craft-platforms"` to docs/conf.py for the sphinx-notfound-page extension so the docs 404 page resolves to the project slug. Approved with all CI (incl. sphinx) green.
84%