Documentation site for the OpenApparatus ecosystem — a small set of open-source tools for procedurally generating reproducible navigation environments for behavioural research.
Built with Docusaurus and deployed to GitHub Pages.
The site has one section per repository in the org:
- Core — the engine-agnostic .NET library.
- Studio — the cross-platform Avalonia desktop app.
- Unity — the Unity Package Manager package.
Plus a shared introduction, getting-started page, and contributing guide.
git clone https://github.com/OpenApparatus/docs.git
cd docs
npm install
npm startThe dev server lives at http://localhost:3000 and hot-reloads on changes.
npm run buildOutputs static HTML to build/. Serve it locally with npm run serve.
Pushes to main trigger the deploy.yml workflow, which builds the site and publishes it to GitHub Pages.
Every page in the rendered site has an "Edit this page" link at the bottom — that opens the source .md file on GitHub. PRs welcome.
For broader contribution guidance see the Contributing page.
MIT — see LICENSE.