ml-eng-lab Documentation Publishing

Canonical repository docs, generated site, wiki signpost, and repository metadata.
Documentation publishing flow Diagram showing README, docs, diagrams, MkDocs build, GitHub Actions, GitHub Pages, wiki, and repository About metadata. README.md entry point and index numbered overview docs/*.md architecture, setup, contracts focused maintenance records HTML diagrams standalone SVG artifacts embedded in architecture page MkDocs Material mkdocs.yml navigation strict local build Automation boundary pages.yml default-branch deploy GitHub Pages published site GitHub Wiki signpost surface Repo About description, topics, URL Status: repo branch carries the site source; Pages serves after the workflow lands on the default branch.

Source

  • README and `docs/` are the canonical in-repo documentation.
  • Diagrams are checked-in HTML/SVG artifacts.

Build

  • MkDocs builds the site in strict mode.
  • The Pages workflow deploys after it exists on the default branch.

Surfaces

  • Wiki remains a concise signpost.
  • Repository About metadata tracks current project identity.