docs: phase 1 — properdocs site scaffolding + GitHub Pages deploy#5
Merged
Conversation
Re-add the pyhaul-style documentation infrastructure stripped during the initial spin-up cleanup. This is infra-only — content reshape lands in phases 3-6. Adds: * ``properdocs.yml`` — site config (mkdocs-material theme; pymdownx admonitions / tabs / superfences; mkdocstrings for the eventual API reference; mkdocs-code-validator runs ``python -c "ast.parse(...)"`` on every Python block at build time so doc-snippets that drift become build-time failures, not silent rot). * ``[dependency-groups] docs`` — properdocs, mkdocs-material, mkdocstrings[python], mkdocs-code-validator (versions matching pyhaul). * ``.github/workflows/docs.yml`` — build + deploy to GitHub Pages on every push to main (paths-filtered to docs/, properdocs.yml, .md, src/). ``properdocs build --strict`` so broken anchors or missing nav entries fail CI. * ``docs/stylesheets/extra.css`` — nav section-header polish (copied from pyhaul). * ``docs/index.md`` — minimal landing page; the README is still the source of truth until phase 4. * ``just docs`` / ``just docs-serve`` — local build + live-reload. * ``renovate.json`` — restore the "docs tools" group + add the four docs deps to the automerge list. * ``[tool.rumdl.per-file-flavor]`` — ``docs/**/*.md = mkdocs`` so the markdown linter accepts admonitions / tabbed code blocks. Nav already includes ``WPT Conformance`` pointing at the existing auto-generated ``docs/wpt-compliance.md``, so the site has one real page from day one. Site target: https://chad-loder.github.io/yarlpattern (Pages source + ``github-pages`` environment configured GH-side in the merge follow-up).
github-actions
Bot
added
the
documentation
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
1 participant
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
Re-add the pyhaul-style documentation infrastructure stripped during the initial spin-up cleanup. Infra-only — content reshape lands in phases 3-6.
properdocs.ymlpython -c "ast.parse(...)"on every Python block so drift = CI failure, not silent rot[dependency-groups] docs.github/workflows/docs.ymlproperdocs build --strictso broken anchors / missing nav entries fail closeddocs/stylesheets/extra.cssdocs/index.mdjust docs/just docs-serverenovate.json[tool.rumdl.per-file-flavor]docs/**/*.md = "mkdocs"Nav already includes WPT Conformance pointing at the existing auto-generated
docs/wpt-compliance.md, so the site has one real page from day one.Site target: https://chad-loder.github.io/yarlpattern (Pages source +
github-pagesenvironment configured GH-side after merge).Test plan
uv sync --group docsresolves;just docsbuilds cleanjust checkpasses (16 lint tools + 580 tests, both lint stacks)docs.ymlbuild_type=workflow; creategithub-pagesenv with branch policymain