pyscript / pyscript/docs

Missing 404 Page

Open
#34 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
17
Forks
20
PR merge metrics
No merged PRs in 30d

Description

If you got to a URL on our (new) docs that doesn't exist (like https://docs.pyscript.net/foo), you get an ugly basic 404 result:

image

I think we need to re-add a custom 404 page or error.html to our docs to help with this. I thought mkdocs automatically generated one, but perhaps there's something about our deployment I don't know.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the docs deployment and its MkDocs configuration, then compare the current behavior with MkDocs' 404-page guidance and GitHub Pages' custom 404 documentation. The work is done when a nonexistent URL such as /foo displays a custom 404 page instead of the basic result.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
devops, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.