Skip to content

docs: migrate to GitHub Pages (httpware.modern-python.org)#38

Merged
lesnik512 merged 12 commits into
mainfrom
docs/migrate-to-gh-pages
Jun 8, 2026
Merged

docs: migrate to GitHub Pages (httpware.modern-python.org)#38
lesnik512 merged 12 commits into
mainfrom
docs/migrate-to-gh-pages

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

  • Replaces ReadTheDocs with GitHub Pages as the authoritative docs host, modeled on the sibling modern-di setup.
  • New URL: https://httpware.modern-python.org.
  • Adds .github/workflows/docs.yml, docs/CNAME, and a docs-deploy recipe in the Justfile.
  • Deletes .readthedocs.yaml (clean cutover).
  • Repoints all references: mkdocs.yml, pyproject.toml, CONTRIBUTING.md, planning/engineering.md. Also fixes already-dead modern-di.readthedocs.io URLs in docs/recipes/modern-di.md and two planning artifacts.

Spec: planning/specs/2026-06-08-mkdocs-gh-pages-migration-design.md

Operational prerequisites (NOT in this diff)

These must be done by a repo admin around the merge — flagging here so they don't get forgotten:

  1. DNS: add a CNAME record httpware.modern-python.orgmodern-python.github.io on the modern-python.org zone.
  2. First-deploy bootstrap: after the first workflow run, go to Settings → Pages and set Source = Deploy from a branch, Branch = `gh-pages` / (root).
  3. HTTPS: once Pages serves the custom domain, tick Enforce HTTPS in Settings → Pages.

Follow-up (separate work, not blocking merge)

  • Archive the ReadTheDocs project at `readthedocs.org/projects/httpware/` so the old URL stops serving stale content.

Test plan

  • Mkdocs `--strict` build succeeds locally.
  • `CNAME` lands in the built site at root.
  • `httpware.modern-python.org` baked into `index.html`.
  • After merge: `Deploy Docs` workflow run on `main` succeeds.
  • After admin completes prereqs above: `https://httpware.modern-python.org/\` loads and matches current RTD content.

🤖 Generated with Claude Code

lesnik512 and others added 12 commits June 8, 2026 21:19
Spec for moving docs hosting from ReadTheDocs (httpware.readthedocs.io)
to GitHub Pages (httpware.modern-python.org), modeled on modern-di.
Single structural PR; clean cutover.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Bite-sized task plan derived from the 2026-06-08 spec; 11 tasks
covering the workflow, CNAME pinning, Justfile recipe, URL flips,
.readthedocs.yaml deletion, and the PR with operational prereqs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@lesnik512 lesnik512 self-assigned this Jun 8, 2026
@lesnik512 lesnik512 merged commit ce607ec into main Jun 8, 2026
5 checks passed
@lesnik512 lesnik512 deleted the docs/migrate-to-gh-pages branch June 8, 2026 18:59
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