📦 Project Tooling & Documentation

Setup guide for .NET tools, documentation generation, and CI/CD pipeline configuration.

🚀 Getting Started

🔧 Install .NET Tools

Restore all required tools defined in the repository:

dotnet tool restore

This installs all tools listed in dotnet-tools.json with locked versions, ensuring a consistent development environment across machines.

📚 Documentation

This project uses DocFX to generate API and static documentation.

🏗️ Build Documentation

Run the following commands:

dotnet build -c Release
dotnet docfx metadata
dotnet docfx build

🌐 Preview Locally

Start a local documentation server:

dotnet docfx build --serve

Then open:

http://localhost:8080

⚙️ CI/CD Pipeline

All secrets are managed at the organization level, so they are automatically available to every repository.

Manage secrets here: https://registry.bongia.mywire.org/org/libraries/settings/actions/secrets

🔐 Available Secrets

Name	Description
`NUGET_REGISTRY_URL`	NuGet registry endpoint used for publishing packages
`NUGET_TOKEN`	Authentication token for NuGet push operations
`DOCKER_REGISTRY_URL`	Docker registry where the documentation image (NGINX-based) is published
`DOCKER_REGISTRY_TOKEN`	Authentication token for Docker image push

🐳 Docker

The generated documentation is packaged and distributed as a Docker image based on NGINX, making it easy to deploy and serve in any environment.

🔒 Security

⚠️ Tokens are sensitive credentials — handle with care.

All tokens are generated via the admin account:

https://registry.bongia.mywire.org/user/settings/applications

Best practices:

Store secrets securely (never commit them)
Restrict access to authorized users only
Rotate tokens periodically

🧩 Notes

Ensure the .NET SDK is installed before running any command
Use Release configuration to generate production-ready documentation
Validate documentation