-
Notifications
You must be signed in to change notification settings - Fork 890
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve "404 not found" pages on the documentation #2951
Comments
@astrojuanlu Given the discussion in #2980 should we now focus our attention on branches for adding 404 pages just for v 0.17.7 and for 0.18.0 onwards (with possible omission of 0.18.0-0.18.4 as they're not indexed)? |
Indeed, we can do a proof of concept with 0.17.7, and if it works extend it to 0.18.5 onwards. For now, let's add a |
_Originally posted by @datajoely in kedro-org/kedro-sphinx-theme#5 |
Missing:
|
cc @stichbury could you help me with (1)? and I'll describe (2) in a bit more detail |
Some ideas for examples in the wild:
![]() (results from https://ably.com/docs/general/push/publis?q=dafd)
![]()
![]()
![]() |
We'll possibly need to add custom tracking for those errors https://community.heap.io/using-the-product-46/possible-to-track-web-errors-like-400-401-403-554?postid=1542#post1542 |
I initially described the problematic navigation in readthedocs/readthedocs.org#10643 (comment), but with the new add-ons, the logic has changed: readthedocs/addons#223 As a result, now it's impossible to land in a 404 page when switching versions. The downside though is that navigating across versions is more difficult now. |
Looking at this again and I'm not convinced there's anything more we can do. Would adding a |
Indeed, I think there's not much for us to do here until we have more clarity on readthedocs/addons#211. Closing for now. |
Description
#2486 fixed #2464, and the current situation is much better than what we had.
However, navigating to old versions of the docs is hard: readthedocs/readthedocs.org#10643
It would be better if 404 pages reflected the navigation structure of each version.
Context
Used very often by @stichbury and the rest of the team to see how a specific page used to look.
Possible Implementation
I think there's an undocumented feature of Sphinx in that one can add a
404.md
page to the docs (if it's documented, I haven't found it). That should be a solution going forward.For older versions, it's more complicated. We could create a branch in the repository for each version we want to amend (not necessarily all of them) that adds such a page.
Apart from all this, we should probably keep the
sphinx-notfound-page
extension for the time being.Possible Alternatives
The text was updated successfully, but these errors were encountered: