diff options
| author | Leitwolf11 | 2026-10-15 18:35:17 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-10-15 18:35:17 +0300 |
| commit | 018696d64cdb4088c0dd502ceab8d8ed9e11543e (patch) | |
| tree | 402412587d273cd488b941878f902d313b47fa41 /Documents/api/namespaces | |
| parent | a460c4c7e922f37705b2be3f1fa7c789f514cd51 (diff) | |
| download | website-018696d64cdb4088c0dd502ceab8d8ed9e11543e.tar.gz | |
Gate the API documentation with DocFX
The Kotlin backend checked its documentation with Dokka; the ASP.NET Core
API had only the compiler warning for a public declaration without a
comment. CI now builds the API reference with DocFX, every warning as an
error, and Documents/api/CheckDocumentation.cs fails when a namespace,
type or member of the reference has no description, internal and
private members included. The setup is the one Progmaweb uses: the
docfx tool pinned in .config/dotnet-tools.json, the configuration and
the namespace description under Documents/api, and the generated
reference ignored.
Diffstat (limited to 'Documents/api/namespaces')
| -rw-r--r-- | Documents/api/namespaces/Progmasoft.Tala.Website.Api.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documents/api/namespaces/Progmasoft.Tala.Website.Api.md b/Documents/api/namespaces/Progmasoft.Tala.Website.Api.md new file mode 100644 index 0000000..de90b81 --- /dev/null +++ b/Documents/api/namespaces/Progmasoft.Tala.Website.Api.md @@ -0,0 +1,10 @@ +--- +uid: Progmasoft.Tala.Website.Api +summary: *content +--- + +<!-- SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com> --> +<!-- SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1 --> + +The API of the language website: the site's own public state at `/api/v1/site` and a liveness probe at `/health`. +It has no account, package, publication or registry endpoint. |