diff options
| author | Leitwolf11 | 2026-10-03 18:42:57 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-10-03 18:42:57 +0300 |
| commit | 08a076a3f880764462410a0b2f855d5bdfba1066 (patch) | |
| tree | 5012d38d7dfc1bdc4cf75c3db7772d3fac7a5a4e /README.md | |
| parent | 01ddcb6071ebdfb08b5ca40c868420b726f4f225 (diff) | |
| download | progmaweb-ci/docfx-require-documentation.tar.gz | |
Describe the stricter documentation gate in the guidesci/docfx-require-documentation
The guides merged from main still said that the DocFX gate does not require
documentation comments. With this branch it does, so:
- docs/DEVELOPMENT.md and README.md list the coverage check next to the
DocFX command and say what fails the gate.
- docs/LIMITATIONS.md no longer lists missing documentation comments as a
limitation.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -96,6 +96,7 @@ dotnet test --project apps/api-tests/Progmaweb.Api.Tests.csproj --configuration dotnet test --project apps/api-tests/Progmaweb.Api.Tests.csproj --configuration Release --coverlet --coverlet-output-format cobertura dotnet tool restore dotnet docfx docs/api/docfx.json --warningsAsErrors +dotnet run docs/api/CheckDocumentation.cs -- docs/api ``` Frontend tests exercise the published locale contract and account/ViGet metadata without starting a production service. @@ -103,7 +104,8 @@ The frontend LCOV and API Cobertura reports are retained as one-day artifacts, t jobs. Only those upload jobs receive `id-token: write`; dependency installation, builds, and tests do not receive OIDC permissions, and fork-originated pull requests skip the upload jobs. CodeQL and Codacy provide static analysis; Dependabot proposes dependency updates without merging them automatically. The DocFX command builds the API reference -and fails on a broken link or an unresolved reference. [Development](docs/DEVELOPMENT.md) explains each check. +and fails on a broken link or an unresolved reference; the check after it fails when any item of the reference has no +description. [Development](docs/DEVELOPMENT.md) explains each check. ## License |