github-such-software/adaptive-multi-protocol-gateway
1
0
Fork 0
mirror of https://github.com/Such-Software/adaptive-multi-protocol-gateway.git synced 2026-10-17 15:41:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Harden public docs gates

Browse Source
This commit is contained in:
jwinterm
2026-07-11 08:59:21 -04:00
parent f0d26933e6
commit d95296da5f
3 changed files with 46 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/autodocs.md
+9 -5
View File
@@ -1,6 +1,6 @@
# Autodocs And Drift Gates
> Status: draft | Updated 2026-07-05 | Applies to: AMPG generated docs
> Status: draft | Updated 2026-07-11 | Applies to: AMPG generated docs
AMPG should publish concise hand-written docs and generate the parts that can drift from
code. Generated artifacts are committed, then checked in CI by regenerating and diffing.
@@ -38,13 +38,17 @@ git diff --exit-code docs/generated schemas openapi.json
python3 tools/docs_check.py
```
`ampg docs check` should verify:
`python3 tools/docs_check.py` verifies:
- every Markdown file starts with a `> Status:` header.
- internal links resolve.
- generated docs are not edited by hand.
- public docs contain no private keys, onion keys, I2P keys, Reticulum identities, or
local production secrets.
- local links stay inside the repository.
- public docs do not name private fixture targets.
- public docs do not contain obvious private-key blocks, common API tokens, or assigned
secret values.
`python3 -m ampg docs generate --check` verifies that generated docs and schemas match
the code-owned metadata.
## Public/private boundary