Skip to content

Move the project docs from docs.levimc.org to levimc.org/<Project>/ - #99

Merged
futrime merged 2 commits into
mainfrom
docs-on-levimc-org
Nov 15, 2026
Merged

futrime merged 2 commits into
mainfrom
docs-on-levimc-org

Conversation

@futrime

@futrime futrime commented Nov 15, 2026

Copy link
Copy Markdown
Member

Do not merge before the switch. The new links (levimc.org/<Project>/) work only once this repository is the organisation site with the domain levimc.org. Merge it at step 5 of MIGRATION.md.

Why

We want one domain. GitHub Pages serves each project repository's site at /<Repo>/ below the organisation site's domain. So if this repository becomes the organisation site (renamed to liteldev.github.io, domain levimc.org), LeviLamina, LegacyScriptEngine, lip, LeviLauncher, BeDD and bedboo appear at levimc.org/<Repo>/ and need no build changes. docs.levimc.org/* then gets a Cloudflare 301 to the same path on levimc.org.

What

  • legacy/: brings over everything LiteLDev/liteldev.github.io served under docs.levimc.org.
    • The redirect pages for /LeviLaunchroid/, /preloader-android/ and /LiteXLoader/ (86 files).
    • The 404 forwarding map, now added to levimc.org's own 404.html. Its wrong-case forwarding also covers BeDD and bedboo.
    • Runs as the last step of npm run build; its tests run in npm test.
  • kit 2.20.0: PROJECTS[].docs, the static chrome, the Doxygen header, the demos and the tools/tests now point at https://levimc.org/<Project>/.
    • New linkcheck --other-sites, for same-origin paths that another build publishes.
    • The cross-site e2e test now serves the docs build at levimc.org/<base>/.
  • levimc.org:
    • isAppPath keeps the router off the docs paths, so it no longer renders its own 404 for them.
    • robots.txt lists the docs sitemaps.
    • The deploy linkcheck treats the docs paths as other sites.
    • The sync job no longer triggers liteldev.github.io.
  • MIGRATION.md: the switch-over steps, the changes each project repository needs, checks and rollback.

Verified

  • npm run typecheck passes. npm test: 67 pass, 0 fail, 1 skipped (the --live check). Mods pnpm test: 147 pass. Mods typecheck passes.
  • npm run build + linkcheck: 3795 internal links, 0 broken.
  • All 47 distinct levimc.org/<Project>/… URLs in the build answer 200 at their current docs.levimc.org address, so they will exist after the switch.
  • Not run: the Playwright smoke tests and the cross-site e2e test.

Prepares this repository to become the organisation site (renamed to
liteldev.github.io, domain levimc.org), so every project's Pages site is
served at levimc.org/<Repo>/ and docs.levimc.org can 301 to it.

- legacy/: the retired docs redirects and the 404 forwarding map, moved
  from LiteLDev/liteldev.github.io (ORIGIN levimc.org; wrong-case
  forwarding now covers BeDD and bedboo). Run as the last build step.
- kit 2.20.0: PROJECTS docs URLs, static chrome, Doxygen header and the
  tests/tools point at https://levimc.org/<Project>/; linkcheck gets
  --other-sites for same-origin paths another build publishes.
- levimc.org: the router leaves the docs paths alone (isAppPath),
  robots.txt lists the docs sitemaps, linkcheck treats them as external.
- MIGRATION.md: the switch-over steps (repo renames, Pages domain,
  Cloudflare 301, project repo changes, checks, rollback).

Merge during the switch (MIGRATION.md, step 5): the new links answer
only once levimc.org is the organisation site's domain.
@futrime
futrime marked this pull request as ready for review November 15, 2026 13:56
@futrime
futrime merged commit 0a4e876 into main Nov 15, 2026
1 check passed
@futrime
futrime deleted the docs-on-levimc-org branch November 15, 2026 13:56
futrime added a commit to LiteLDev/LeviLamina that referenced this pull request Nov 15, 2026
The project docs are served at levimc.org/<Project>/ now (LiteLDev/liteldev.github.io#99): canonical URLs, sitemap, linkcheck origin, the kit check and links point at https://levimc.org. docs.levimc.org redirects to the same path.
futrime added a commit to LiteLDev/LegacyScriptEngine that referenced this pull request Nov 15, 2026
The project docs are served at levimc.org/<Project>/ now (LiteLDev/liteldev.github.io#99): canonical URLs, sitemap, linkcheck origin, the kit check and links point at https://levimc.org. docs.levimc.org redirects to the same path.
futrime added a commit to LiteLDev/lip that referenced this pull request Nov 15, 2026
The project docs are served at levimc.org/<Project>/ now (LiteLDev/liteldev.github.io#99): canonical URLs, sitemap, linkcheck origin, the kit check and links point at https://levimc.org. docs.levimc.org redirects to the same path.
futrime added a commit to LiteLDev/LeviLauncher that referenced this pull request Nov 15, 2026
The project docs are served at levimc.org/<Project>/ now (LiteLDev/liteldev.github.io#99): canonical URLs, sitemap, linkcheck origin, the kit check and links point at https://levimc.org. docs.levimc.org redirects to the same path.
futrime added a commit to LiteLDev/BeDD that referenced this pull request Nov 15, 2026
The project docs are served at levimc.org/<Project>/ now (LiteLDev/liteldev.github.io#99): canonical URLs, sitemap, linkcheck origin, the kit check and links point at https://levimc.org. docs.levimc.org redirects to the same path.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant