docs(site): MkDocs Material documentation site for GitHub Pages - #786
Merged
Conversation
Publishes the how-to guides (docs/development, ~80), the getting-started tutorial, and the project overview to a browsable, searchable site at docs.nene-php.com — addressing the "discovery" gap named in publication-strategy.md. nene-php.com stays the live demo app. - mkdocs.yml: Material theme (light/dark, search, code copy), docs/ as source. Nav scope is curated via awesome-pages (docs/.pages) to Home + Overview + Getting Started + How-to Guides; unlisted pages (ADR, roadmap, field-trials) still build so cross-links keep resolving, just omitted from the nav. - docs/index.md: site landing (the in-repo docs/README.md is excluded to avoid an index/README collision; nothing links to the top-level README). - docs/CNAME: docs.nene-php.com. - .github/workflows/docs.yml: build on PR (validation) + push to main, deploy to Pages via actions/deploy-pages on main only. - requirements-docs.txt: mkdocs-material + awesome-pages. Manual steps after merge: enable Pages (Source: GitHub Actions) and add a DNS CNAME docs.nene-php.com → hideyukimori.github.io. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
setup-python's cache:pip defaults to globbing requirements.txt/pyproject.toml, which don't exist here; set cache-dependency-path explicitly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
hideyukiMORI
enabled auto-merge (squash)
May 29, 2026 14:33
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.
Summary
Stands up a browsable, searchable documentation site (MkDocs Material) for publishing to GitHub Pages at
docs.nene-php.com. Directly targets the #1 gap named indocs/publication-strategy.md— "The main gap is not implementation depth. The main gap is discovery." — by surfacing the ~80 how-to guides that currently only exist as raw.mdindocs/development/.nene-php.comstays the live demo app; the docs site is a separate subdomain.What's included
mkdocs.yml— Material theme (light/dark toggle, search, code copy, GitHub edit links),docs/as the source.awesome-pages(docs/.pages): Home → Overview → Getting Started → How-to Guides. Unlisted pages (ADR, roadmap, field-trials, …) are still built so cross-links keep resolving — they're just omitted from the navigation (validation.nav.omitted_files: ignore).docs/index.md— a landing page with cards. The in-repodocs/README.mdis excluded from the build to avoid an index/README URL collision (nothing links to the top-level README).docs/CNAME—docs.nene-php.com..github/workflows/docs.yml— builds on PR (validation only) and on push to main, deploys to Pages viaactions/deploy-pageson main only.requirements-docs.txt—mkdocs-material,mkdocs-awesome-pages-plugin.Scope (as agreed)
How-to guides (
docs/development) + tutorial (building-a-service) + overview (project.md). Easy to widen later (deployment/api/frontend) by editingdocs/.pages.Manual steps after merge (owner)
CNAME docs.nene-php.com → hideyukimori.github.io.Until step 1, the
buildjob passes butdeployhas nothing to publish to.Test plan
.pages).buildjob on this PR confirmsmkdocs buildsucceeds (couldn't run mkdocs in the dev sandbox — no pip).docs.nene-php.comonce DNS propagates.🤖 Generated with Claude Code