mirror of
https://github.com/Such-Software/adaptive-multi-protocol-browser.git
synced 2026-10-17 14:31:46 +02:00
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# Autodocs
|
|
|
|
> Status: draft | Updated 2026-07-07 | Applies to: AMPB maintainers
|
|
|
|
Public docs should stay concise and current. Code-owned behavior is documented from code,
|
|
while manual docs explain stable concepts and operator-facing choices.
|
|
|
|
## Generated Docs
|
|
|
|
Run:
|
|
|
|
```sh
|
|
python3 -m ampbrowser docs generate
|
|
```
|
|
|
|
Check for drift:
|
|
|
|
```sh
|
|
python3 -m ampbrowser docs generate --check
|
|
```
|
|
|
|
Generated files live under `docs/generated/` and must not be edited by hand. They cover
|
|
route rules, active transports, browser backend strategy, adapter contracts, candidate
|
|
transports, and platform capabilities. Browser source trees, object directories, caches,
|
|
and artifacts belong under `/tmp/ampb-browser-build` or another explicit external build
|
|
workspace, not this repo.
|
|
|
|
## Manual Docs
|
|
|
|
Manual public docs must include a status header near the top and should avoid strategy
|
|
notes, checkpointing, timelines, private addresses, local hostnames, credentials, and
|
|
deployment inventory.
|
|
|
|
Private notes belong in `docs/private/`. That directory is ignored and should remain
|
|
absent from commits.
|
|
|
|
## Link And Header Check
|
|
|
|
Run:
|
|
|
|
```sh
|
|
python3 tools/docs_check.py
|
|
```
|