← Back to issue list

docs: declare slug in config

View original Github issue

Metadata

Project
craft-grammar
Number
#207
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged into main after 2 approvals with all CI checks passing. It adds the project slug to the Sphinx config (+2/-2 lines, 1 file) to configure the sphinx-notfound-page extension, confirmed by the live and PR-build /oops 404 URLs in the description.

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/craft-grammar/oops PR build 404 page: https://canonical-ubuntu-documentation-library--207.com.readthedocs.build/craft-grammar/207/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 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.
stealth/space-bunny-alpha — closed resolved Merged PR #207, adding the Sphinx project slug so Canonical Sphinx can configure sphinx-notfound-page and render the custom 404 page for production and PR builds.
qwen/qwen3.6-35b-a3b — — Merged after two approvals and passing all CI checks. The change declares the slug in the configuration to enable the sphinx-notfound-page extension for Canonical Sphinx, ensuring correct 404 page routing for production and PR builds.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
needs review Configures Canonical Sphinx to declare a slug for the sphinx-notfound-page extension, enabling a custom 404 page. Approved by two reviewers with all CI checks passing and ready to land.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 95
needs review Adds a slug configuration to Canonical Sphinx to enable the sphinx-notfound-page extension for custom 404 pages. PR is approved by two reviewers, passes all CI checks, and has no unresolved comments.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 5
Confidence: 90
needs review Adds a slug configuration 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: 0
Complexity: 5
Confidence: 90
needs review Adds a slug configuration for the Sphinx notfound-page extension to standardize 404 pages. Currently pending initial 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.
88%
#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.
87%
#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.
87%
#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.
86%
#583 docs: declare slug in config starbase merged Merged #583, adding the docs slug to Sphinx config so Canonical Sphinx can resolve the custom sphinx-notfound-page 404 route.
84%
#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.
84%
#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.
84%