Adds more basic info to the default 404 page #9656
Conversation
|
I think the message should clearly communicate this page belong to a documentation project that it's hosted by Read the Docs but it's not a 404 page on Read the Docs itself. To me, the "Back to the main page" is confusing in that regard. I would expect that I'd arrive at the main page of the documentation that I'm looking for. Why not include the information about the project on this PR as well? I think that will work to remove the ambiguity in the message. |
|
I'm writing a separate PR about adding context to the 404 page. See the PR description:
|
|
I do agree with Manuel that the |
|
Text updated + screenshot in description updated. I added |
| @@ -16,6 +16,10 @@ | |||
| {% block language-select-form %}{% endblock %} | |||
|
|
|||
| {% block content %} | |||
| <p>{% blocktrans context "404 page" %}This is a 404 error page. The link you have followed or the URL that you entered did not work. It might be that the documentation has been updated.{% endblocktrans %}</p> | |||
|
|
|||
| <a href="/">{% blocktrans with site_name=request.get_host|default:_("this site") context "404 page" %}Back to the front page of {{ site_name }}{% endblocktrans %}</a> | |||
Co-authored-by: Eric Holscher <[email protected]>
There was a problem hiding this comment.
I don't see too much value on this PR, but I'm fine merging it if you consider. I think that #9657 is the way to go and will replace this PR.
Another extra step related to "improve 404 page" work, IMO, would be to have _ completely different_ 404 pages for "application 404 page" and "documentation 404 page". That way, it will be a lot more clear if that 404 page the user reached is related to Read the Docs itself or if it's part of the project they wanted to read documentation about.
|
@humitos I do see some value here: Instead of having an almost arrogant 404 page that doesn't tell the user anything, we now have a friendlier version that on a more fundamental level says what might have gone wrong. I agree that it can be improved through more context, this PR was meant as the fastest way to improve the current situation + a bit of exercise before a larger changeset. Contextualizing the current 404 page or making 2 versions definitely makes sense, but I'm sure it's also more complex and requires a bit more ideas to be tossed around :) |
|
I like the ascii art, but the word "yet" at the very end is misleading, perhaps we should remove that in future updates? |
Addresses #2551 with a very simple improvement. The 404 page context is still unaware of what project it belongs to, that should follow in a different update.
TODO:
📚 Documentation previews 📚
docs): https://docs--9656.org.readthedocs.build/en/9656/dev): https://dev--9656.org.readthedocs.build/en/9656/