Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs/DEVELOPMENT.md
diff options
context:
space:
mode:
authorLeitwolf112026-10-03 18:42:57 +0300
committerLeitwolf112026-10-03 18:42:57 +0300
commit08a076a3f880764462410a0b2f855d5bdfba1066 (patch)
tree5012d38d7dfc1bdc4cf75c3db7772d3fac7a5a4e /docs/DEVELOPMENT.md
parent01ddcb6071ebdfb08b5ca40c868420b726f4f225 (diff)
downloadprogmaweb-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 'docs/DEVELOPMENT.md')
-rw-r--r--docs/DEVELOPMENT.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
index 66822de..c5da810 100644
--- a/docs/DEVELOPMENT.md
+++ b/docs/DEVELOPMENT.md
@@ -122,11 +122,15 @@ version, so a local run and CI use the same tool.
```text
dotnet tool restore
dotnet docfx docs/api/docfx.json --warningsAsErrors
+dotnet run docs/api/CheckDocumentation.cs -- docs/api
```
-or `just api-docs`. The output goes to `docs/api/_site`, which is ignored by Git. A broken link or an unresolved
-reference fails the build. The gate does not yet require documentation comments on the C# declarations; see
-[Known limitations](LIMITATIONS.md).
+or `just api-docs`. The output goes to `docs/api/_site`, which is ignored by Git.
+
+The gate fails on a broken link or an unresolved reference, on a public declaration without a documentation comment,
+and on any namespace, type or member of the reference that has no summary, internal and private ones included. A new
+declaration therefore needs its `<summary>` in the same change. [The API reference page](api/index.md) describes the
+three parts of the gate and how a namespace is described.
## Conventions