Skip to content

feat(docs): docs site on GitHub Pages - #15

Merged
agus-darmawan merged 4 commits into
mainfrom
feat/docs-site
Nov 2, 2026
Merged

agus-darmawan merged 4 commits into
mainfrom
feat/docs-site

Conversation

@agus-darmawan

Copy link
Copy Markdown
Member

The docs as a site on GitHub Pages, https://darmawanrobotics.github.io/HotDog/, built from the same Markdown as the PDFs.

  • VitePress in docs/ (home, overview, commissioning, operations, the three guides, a page per package, changelog, contributing), local search, light and dark in HotDog's colours.
  • .vitepress/bridge.mts reads the guides as they are: !!! note admonitions, {: .class}, {{ parameter_reference }}; chapters numbered as in the PDF, a head per guide with version and PDF download; relative links go to a page, a PDF or the file on GitHub.
  • Package pages and the changelog mirror src/*/README.md, CHANGELOG.md, CONTRIBUTING.md: no copies.
  • docs/pdf/parameters.py: the parameter reference for the PDF and the site, standard library only.
  • .github/workflows/docs.yml: build on pull requests, publish from main once Pages is on (Settings → Pages → Source: GitHub Actions).

Generated by Claude Code

@agus-darmawan
agus-darmawan merged commit b9c20fb into main Nov 2, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant