docs: Material for MkDocs site published to GitHub Pages#31
Merged
Conversation
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 public documentation site for WhyGraph built with Material for MkDocs, published to GitHub Pages via a dedicated Actions workflow. Executes the round-5-reviewed plan in
plans/docs-site-plan.md.The defining constraint: the old README had drifted out of sync with the shipped product (dead
render/servecommands, renamed MCP tools/prompts, a "confidence score" that doesn't exist). So every page is sourced from the live CLI--helpand MCP registrations, not the README — and the README is trimmed to a pointer.What's here
mkdocs.yml— Material theme with the "fancy" treatment: card-grid landing, social (Open Graph) cards, instant nav + progress bar, light/dark toggle, code-copy, per-page "last updated" dates.docs/— Home, Getting Started (install/quickstart), User Guide (concepts/scanning/editors/MCP usage), Docker & Self-Hosting (docker/service), Reference (CLI/MCP/config/providers), Roadmap. All written in one locked voice (§5.1: second person, imperative, show-before-tell, asides in admonitions).deploy/service.md— the third-party-service model (real apps →whygraph-mcpfor git analysis), with a Mermaid architecture diagram.pyproject.toml— newdocsdependency group (uv sync --group docs).Makefile—make docs/make docs-build..github/workflows/docs.yml— least-privilege Pages-via-Actions deploy (full-history checkout + Cairo/Pango for social cards).README.md— trimmed to pitch + Quickstart + "Full documentation →" link.Verification
uv run mkdocs build --strict→ clean (no broken links / missing nav).render/serve/whygraph_search/--llm-recent/claude-desktop/confidence).--help+mcp/*.pyregistrations.CI=truebuild degrades gracefully without Cairo (cards generate in CI, skip locally).docs/;ci-code-checks.yml/cd-deploy-whygraph.ymluntouched.GitHub Pages must be set to Settings → Pages → Source → GitHub Actions (or
gh api -X POST repos/mtrdesign/whygraph/pages -f build_type=workflow). A committed workflow can't set this for itself on the first run. Until it's flipped, thebuildjob goes green butdeploycan't publish.