Skip to content

How to Run the Site Locally

This is the Local AI Agent Wiki — a static site built with MkDocs + Material for MkDocs, the stack recommended by PHASE 0 architecture research (docs/00-architecture-research.md).

The landing page lives at docs/index.md. Wiki content pages live in content/ and are symlinked into docs/content/ so they are served by the same MkDocs build.

Prerequisites

  • Python 3.14 (system or venv)
  • The packages listed in requirements.txt (installed via pip):
  • mkdocs==1.6.1
  • mkdocs-material==9.7.7
  • mkdocs-llmstxt==0.5.1

Development (live reload)

From the project root:

mkdocs serve

Then open http://localhost:8000 in a browser. The landing page is the home page. Wiki pages are under /content/<category>/<slug>/ (e.g. /content/inference-engines/overview/).

Build (static output)

mkdocs build

Output goes to site/. After building, the site can be served from the site/ directory or deployed via the publish script (scripts/publish.py) — see docs/publish-pipeline.md (PHASE 3) for the full publish/deploy flow.

Verifying locally

  1. Landing page: Visit http://localhost:8000 — the hero, features, DOCS PREVIEW, about, and CTA sections should all render with the Nothing/TE aesthetic (dot-matrix Doto headlines, Inter body, monochrome + one accent).

  2. Fonts: Open browser dev tools → Network tab → filter for woff2. Two font files should load from /assets/fonts/: Doto-ROND-wght.woff2 and Inter-opsz-wght.woff2. No Google Fonts requests should appear.

  3. Content pages: Visit http://localhost:8000/content/inference-engines/overview/ to confirm a wiki page renders with the custom stylesheet applied.

  4. Wiki quality gate: Run the deterministic quality checks:

sh python3 scripts/check-wiki.py

This validates front-matter, heading structure, and internal links across all content/ pages — including the pages the landing page's DOCS PREVIEW cards link to.

File ownership

  • mkdocs.yml — site configuration
  • docs/index.md — landing page
  • overrides/ — theme template (landing.html)
  • assets/css/ — custom stylesheets (fonts.css, extra.css)
  • assets/fonts/ — self-hosted Doto + Inter woff2 fonts

The content/ directory is owned by PHASE 2a and its pages should not be modified here.