docs: declare slug in config
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR itself was merged into main as commit 390d4b3, adding the three-line `slug` declaration to docs/conf.py; the setting is still present at HEAD (docs/conf.py lines 83-84). Review was approved by one maintainer and all CI checks, including the sphinx build, passed.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [X] Have you followed the guidelines for contributing?
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `make lint && make test`?
---
Canonical Sphinx uses this to configure the sphinx-notfound-page extension.
Live 404 page: https://documentation.ubuntu.com/craft-platforms/oops
PR build 404 page: https://canonical-ubuntu-documentation-library--261.com.readthedocs.build/craft-platforms/en/261/oops
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #261 as commit 390d4b3, declaring the documentation slug in Sphinx config so sphinx-notfound-page renders the proper 404 page. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #261, declaring the documentation slug in Sphinx config for sphinx-notfound-page; review was approved and all CI checks passed. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged a documentation update declaring a slug in the configuration to enable the sphinx-notfound-page extension for custom 404 pages. Approved by one reviewer and passed all CI checks. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Configures sphinx-notfound-page extension by declaring a slug in the documentation config. All CI checks pass. Awaiting maintainer review. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
5
Complexity:
5
Confidence:
90
|
needs review | Adds a slug configuration to enable the sphinx-notfound-page extension for consistent 404 pages. Currently pending maintainer review with all CI checks passing. |
Update history
| Date | Change |
|---|---|
| updated | |
| updated | |
| updated | |
| created |
Related work
-
Related To:
craft-platforms#583
(confidence 35%)
A commit8f23a8b carries the identical title 'docs: declare slug in config (#583)' in the commit index, suggesting the same docs-slug change was applied again on another branch; the issue/PR lookup for #583 returns no data, so the relationship is unconfirmed.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #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. | |
| #603 feat: add doc_slug to init | rockcraft | merged | Merged PR #603 added doc_slug to init for reference-documentation messages and enabled it for flask-framework; landed as commit 56b3ecdb. | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged PR #720 as commit 278feb8d, migrating craft-parts docs to canonical-sphinx and removing legacy configuration across three files. |