Docs Site

The repository documentation site is built with Lunet and lives under site/.

It includes both:

article-based guides and reference pages written in Markdown
generated .NET API reference produced from src/Spline/Spline.csproj

Local commands

dotnet tool restore
bash ./build-docs.sh

To validate the generated output with repository-specific assertions:

bash ./check-docs.sh

To run a local dev server with watch mode:

bash ./serve-docs.sh

You can override the bind address and port with DOCS_HOST and DOCS_PORT.

API reference generation

The API reference is generated by Lunet's api.dotnet integration from the Spline project in Release configuration. The generated output is published under site/.lunet/build/www/api/.

Deployment

The docs.yml GitHub Actions workflow builds the site and deploys site/.lunet/build/www to GitHub Pages.