Project Structure & Module Organization

This repository is a MkDocs site with a small Cloudflare Worker for canonical redirects.

  • Content: content/ — pages, including content/articles/ and scaffolds in content/articles/.templates/.
  • Snippets: content/snippets/ — reusable markdown fragments (e.g. social-links.md) included via pymdownx.snippets.
  • Automation: scripts/ — new_article.py, postprocess_sitemap.py, shared_config.py (reads site_url from mkdocs.yml).
  • Theme: overrides/ — custom MkDocs templates (main.html reads from config.extra.* for theme/copyright).
  • Build output: site/ is generated; do not treat it as source (often gitignored locally).
  • Config: mkdocs.yml (canonical — extra: section holds identity, contact, theme, copyright, social), mkdocs.local.yml (local dev), wrangler.toml (worker config + [vars] for env), worker.js.
  • Project meta: project/ — changelog, troubleshooting, plans, KIV, research, build (see project/plans/README.md).
  • Agent docs: content/agents/ — long-form guidelines for assistants (not aimed at site visitors; robots: noindex).

Python baseline: pyproject.toml (Python 3.10+). Use 4 spaces in Python; consistent YAML indentation in MkDocs configs.