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

summaryrefslogtreecommitdiffhomepage
path: root/docs/api
diff options
context:
space:
mode:
authorLeitwolf112026-10-03 16:35:42 +0300
committerLeitwolf112026-10-03 16:35:42 +0300
commit228d8a82bc8e572f9a77fa327882d96e53fb362c (patch)
tree52a16cb40917c065f0143dba423d01de8902a96a /docs/api
parent4c803fe10d3120a7dc7f594a1fb2eb205eca34fc (diff)
parentfe06570c56a29e469fef9e8b42b4dbe6031cbfb4 (diff)
downloadprogmaweb-228d8a82bc8e572f9a77fa327882d96e53fb362c.tar.gz
Merge remote-tracking branch 'origin/main' into chore/ai-crawler-ruleschore/ai-crawler-rules
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/docfx.json26
-rw-r--r--docs/api/index.md19
-rw-r--r--docs/api/toc.yml7
3 files changed, 52 insertions, 0 deletions
diff --git a/docs/api/docfx.json b/docs/api/docfx.json
new file mode 100644
index 0000000..e10a9b0
--- /dev/null
+++ b/docs/api/docfx.json
@@ -0,0 +1,26 @@
+{
+ "metadata": [
+ {
+ "src": [
+ {
+ "src": "../../apps/api",
+ "files": ["Progmaweb.Api.csproj"]
+ }
+ ],
+ "dest": "reference",
+ "includePrivateMembers": true
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": ["index.md", "toc.yml", "reference/**/*.yml"]
+ }
+ ],
+ "dest": "_site",
+ "globalMetadata": {
+ "_appTitle": "Progmaweb API",
+ "_enableSearch": false
+ }
+ }
+}
diff --git a/docs/api/index.md b/docs/api/index.md
new file mode 100644
index 0000000..868fff1
--- /dev/null
+++ b/docs/api/index.md
@@ -0,0 +1,19 @@
+<!--
+SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com>
+SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1
+-->
+
+# Progmaweb API
+
+Reference documentation of the Progmaweb account service, generated by DocFX
+from the XML documentation comments of `apps/api`.
+
+The service is an application, not a library, so most of its types are
+internal. The reference includes them: it documents the code for the people
+who maintain it.
+
+Build it from the repository root:
+
+```sh
+docfx docs/api/docfx.json --warningsAsErrors
+```
diff --git a/docs/api/toc.yml b/docs/api/toc.yml
new file mode 100644
index 0000000..cf49dc1
--- /dev/null
+++ b/docs/api/toc.yml
@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Progmasoft <support@progmasoft.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later WITH AdditionRef-Progmasoft-Patent-Grant-1.1
+
+- name: Overview
+ href: index.md
+- name: Reference
+ href: reference/