Doc Building & Tools¶
SmrtHub ships a repeatable documentation toolchain so every contributor can build, serve, and publish the site without bespoke setup. This hub explains what lives in the section and points you to the two working guides.
When to use this section¶
- You need the Build & Serve walkthrough for local previews or to regenerate auto docs.
- You want the Dev Tools index of PowerShell helpers (clean/build tasks, packaging, supervisor manifest tokens).
- You are wiring new automation and need to understand how component READMEs, API generators, and mkdocstrings feed into the site.
Quick map¶
| Guide | What it covers | Run it when |
|---|---|---|
| Build & Serve the Docs | MkDocs toolchain, VS Code tasks, regeneration scripts, private publishing | You need to preview docs locally, refresh auto-generated pages, or package the site artifact |
| SmrtHub Dev Tools | Master clean/build scripts, per-app helpers, Python packaging, test runners, solution generators | You are cleaning or rebuilding the repo, packaging PythonApp, or running scripted test suites |
Contributor reminders¶
- Component READMEs and
README.Files/*.mdremain the canonical sources; automation mirrors them intodocs/components/auto/**and policy folders. - Do not hand-edit generated Markdown (auto component docs, .NET API pages). Regenerate instead.
- Keep asset updates aligned with the Asset Policy and use the provided VS Code tasks (
📖 Build & Serve MKDocs,📚 Build Complete Documentation) to stay on the pinned toolchain.