Skip to content

Development ​

Machine profile this project is tuned for: MacBook Air M4, 16 GB RAM, 256 GB internal SSD, 1 TB external SSD. No Docker, no local LLMs; rust-analyzer alone claims 3–6 GB and the chassis is fanless — keep heavyweight processes few.

The documentation site ​

The Markdown in docs/ is also published as a VitePress site. It is an npm package of its own, in docs/, with VitePress pinned exactly and the lockfile committed; it shares nothing with desktop/ or npm/. From docs/:

bash
npm ci                # install exactly what the lockfile records
npm run dev           # serve with live reload
npm run build         # build into docs/.vitepress/dist/
npm run check-links   # after a build: check every link and anchor
npm run preview       # serve the build as it will be deployed

The site's configuration is in .vitepress/config.mts. A relative link to a file outside docs/ becomes a link to that file on GitHub, and the build fails if the file does not exist. The docs workflow builds and link-checks the site on every pull request, and publishes it to GitHub Pages from main.

Released under the Apache-2.0 licence.