1. Home
  2. Docs
  3. Reference
  4. Docs Pipeline

Docs Pipeline

RibbonControl uses Lunet for the static docs site and generated .NET API reference.

Important files:

  • site/config.scriban
  • site/menu.yml
  • site/articles/**
  • site/.lunet/includes/_builtins/bundle.sbn-html
  • site/.lunet/layouts/_default.api-dotnet*.sbn-md
  • .config/dotnet-tools.json
  • build-docs.sh / build-docs.ps1
  • serve-docs.sh / serve-docs.ps1
  • .github/workflows/docs.yml

Local commands:

dotnet tool restore
./build-docs.sh
./serve-docs.sh

PowerShell equivalents:

dotnet tool restore
./build-docs.ps1
./serve-docs.ps1

The build scripts start from a clean site/.lunet/build directory so template and API-layout overrides are always reflected in local output.

CI behavior:

  • the main CI workflow builds the docs site to validate structure and API generation,
  • the main CI workflow uploads the built docs site as an artifact,
  • the docs workflow publishes site/.lunet/build/www to GitHub Pages on pushes to main and master.