Skip to content

docs(site): MkDocs Material documentation site for GitHub Pages - #786

Merged
hideyukiMORI merged 2 commits into
mainfrom
docs/mkdocs-site
May 29, 2026
Merged

docs(site): MkDocs Material documentation site for GitHub Pages#786
hideyukiMORI merged 2 commits into
mainfrom
docs/mkdocs-site

Conversation

@hideyukiMORI

Copy link
Copy Markdown
Owner

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 in docs/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 .md in docs/development/.

nene-php.com stays 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.
  • Curated nav via 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-repo docs/README.md is excluded from the build to avoid an index/README URL collision (nothing links to the top-level README).
  • docs/CNAMEdocs.nene-php.com.
  • .github/workflows/docs.yml — builds on PR (validation only) and on push to main, deploys to Pages via actions/deploy-pages on main only.
  • requirements-docs.txtmkdocs-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 editing docs/.pages.

Manual steps after merge (owner)

  1. Settings → Pages → Source: GitHub Actions (enables the deploy).
  2. DNS: add CNAME docs.nene-php.com → hideyukimori.github.io.

Until step 1, the build job passes but deploy has nothing to publish to.

Test plan

  • YAML syntax validated locally (mkdocs.yml, workflow, all .pages).
  • CI build job on this PR confirms mkdocs build succeeds (couldn't run mkdocs in the dev sandbox — no pip).
  • Post-merge: site renders at the Pages URL, then at docs.nene-php.com once DNS propagates.

Note: the two file pairs I earlier flagged as possible duplicates (cors.md/cors-and-csrf.md, invitation-token.md/invitation-tokens.md) turned out to be distinct (class guide vs. concept/pattern guide) — no cleanup needed.

🤖 Generated with Claude Code

hideyukiMORI and others added 2 commits May 29, 2026 23:31
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
hideyukiMORI enabled auto-merge (squash) May 29, 2026 14:33
@hideyukiMORI
hideyukiMORI merged commit aa41a29 into main May 29, 2026
4 checks passed
hideyukiMORI added a commit that referenced this pull request May 29, 2026
Covers the session that finished the 50-trial Nene\Kit field-trial wave
(FT307–316), the post-v0.3.0/ADR-0014 docs refresh, and standing up the
MkDocs documentation site at docs.nene-php.com (PRs #773#786).

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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