# Tala website API Reference documentation of the website's ASP.NET Core API, generated by DocFX from the XML documentation comments of `backend/Progmasoft.Tala.Website.Api`. The reference includes internal and private members: it documents the code for the people who maintain it. Build and check it from the repository root: ```sh dotnet tool restore dotnet docfx Documents/api/docfx.json --warningsAsErrors dotnet run Documents/api/CheckDocumentation.cs -- Documents/api ``` ## What the gate requires Three things fail the check, locally and in CI: - **A broken link or an unresolved reference.** DocFX runs with every warning treated as an error. - **An undocumented public declaration or a wrong `cref`.** The API project compiles its XML documentation, and the build treats the compiler's documentation warnings as errors. - **Any undocumented item of the reference.** `CheckDocumentation.cs` reads the metadata DocFX generated and fails when a namespace, type or member has no summary, internal and private members included. A namespace has no declaration that could hold a comment. Its description is a file in `namespaces/`, named after the namespace.