Repository navigation
chore(docs): remove the pre-mike Sphinx site from the gh-pages root - #207
Merged
Merged
Conversation
- 18 root entries were frozen at 2026-07-07 and never updated again - an unversioned path returned 200 with superseded content, so a status check could not detect the stale link - the root 404.html went too: its assets point at /Tools/, never /osw-python/ - keeps .nojekyll and every path mike writes Closes #205
simontaurus
requested review from
simontaurus
and removed request for
SimonStier
September 23, 2026 02:22
simontaurus
approved these changes
Sep 23, 2026
simontaurus
left a comment
Contributor
There was a problem hiding this comment.
ideally non-existing old url redirect to the main page, but since the documentation was not much used previously not a critical point
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #205.
Note on the base branch
This targets
gh-pages, notmain. Issue #205 is not a source change: theleftovers live only on the build-output branch.
Changes
Removes 18 root entries (63 files) and adds a new root
404.htmlthatredirects missing pages.
404.html,Makefile,assets,auth,authors,changelog,conf.py,contributing,controller,license,model,objects.inv,osw,readme,requirements.txt,search,tools,tutorialsAt the merge base 15de5cd, the root tree goes from 53 entries to 36: 35 kept entries plus the new
404.html. Merged into the currentgh-pages, which has gained the versions 2.8.1 to 2.9.1 since, the root has 40 entries.Rationale
These are the part of the site deployed before mike that mike did not replace. That site was built with MkDocs.
conf.pyandMakefileamong them are Sphinx build files, andrequirements.txtlists both MkDocs and Sphinx packages. Every entryis byte-identical to
641d919,
deployed on 2026-07-07. The last commit that changed these entries is
327982e,
on 2026-07-02. They will never update again.
They are worse than absent. An unversioned path returns 200 and serves a
superseded page, so checking a documentation link by status code passes while
the reader sees content from July.
404.htmlis included for a separate reason. GitHub Pages serves a custom 404only from the root copy, so this file is the live 404 page. Its assets point at
/Tools/assets/...while the site is served at/osw-python/, a wrongsite_urlat build time. Every asset it requests under/Tools/returns 404, so it has notrendered correctly since the repository was renamed from
Toolstoosw-python. mike writes a correctlatest/404.html, but Pages ignoresper-directory copies.
Kept
.nojekyll. Its blob matches the July one only because the file is empty.index.html,versions.json,sitemap.xml,sitemap.xml.gz,dev,latest, and the version directories (2.0.0to2.8.0at the merge base,2.0.0to2.9.1on the currentgh-pages).Nothing under
latest/,dev/or any version directory is touched.Redirect of missing pages
The new root
404.htmlreplaces the old one. It has no external assets. Forevery missing path, a short inline script redirects to the current page of a
removed pre-mike path, or to the main page
/osw-python/when there is none.Without JavaScript, a meta refresh redirects to the main page. The HTTP status
of a missing path stays 404. mike writes only its own paths, so the file
remains through later deploys.
The removed paths below return 404 after this change and redirect as listed.
The pre-mike layout differs from the current one, so several have no same-named
replacement.
/tools//latest/tools//osw//latest/api/core//controller//latest/api/controller//model//latest/api/model//auth//latest/api/auth//license/,/authors//latest/about//tutorials/,/contributing/,/changelog/,/readme/,/search/CI
gh-pagescarries no.github/directory and nopyproject.toml, so noworkflow runs on a pull request against it. No checks will appear. The merge
triggers a Pages build, which publishes the pruned root.
The redirect script was tested with Node against 17 paths, including every removed path in the table and paths outside it.