Docs Update Checklist

Last reviewed: 2026-07-05

Use this checklist when changing worker behavior.

Change type	Update core docs	Update state docs	Also inspect
Worker role or ownership boundary	core/PythonServerRole.md	state/CurrentImplementationMap.md, state/RecentDecisions.md	AGENTS.md only if concise operating contract changes.
Architecture/module boundary	core/SystemArchitecture.md	state/ModuleMap.md, state/CurrentImplementationMap.md	docs/AnuvaPythonServer_SystemDescription.md
Unity command/event/protocol change	core/UnityCommunicationProtocol.md	state/UnityProtocolMap.md, state/TestMap.md, state/KnownGaps.md	Unity tests and any Unity follow-up docs.
Render lifecycle/status/progress change	core/RenderJobLifecycle.md	state/RenderJobFlowMap.md, state/TestMap.md, state/KnownGaps.md	docs/AnuvaWeb_API_Doc.md if API state changes.
Web App endpoint/model/auth/upload change	core/WebAppIntegration.md	state/EnvAndServices.md, state/RenderJobFlowMap.md, state/KnownGaps.md	Web App repo and Engineering Handbook follow-up if cross-repo contract changes.
Simulator scenario or endpoint change	core/LocalSimulationAndTesting.md	state/TestMap.md, state/ScriptsAndCommands.md, state/KnownGaps.md	docs/User_Guide.md for manual flow changes.
Config key/env var/default port/path change	core/ConfigurationAndEnvironment.md	state/EnvAndServices.md, state/ScriptsAndCommands.md	docs/Operations.md, launcher scripts.
Error handling/recovery/diagnostics change	core/ErrorHandlingAndRecovery.md	state/KnownGaps.md, state/TestMap.md	Redaction/security tests.
Test command or coverage change	core/TestingAndVerification.md	state/TestMap.md, state/ScriptsAndCommands.md	AGENTS.md if required checks change.
Deployment, NSSM, Windows service change	core/ConfigurationAndEnvironment.md, core/ErrorHandlingAndRecovery.md	state/EnvAndServices.md, state/ScriptsAndCommands.md, state/KnownGaps.md	docs/Operations.md, Anuva Engineering Handbook follow-up if shared policy changes.

Before handing back docs changes:

1. Check links between docs/core and docs/state.
2. Keep concepts in core docs and file/status maps in state docs.
3. Run git diff --check.
4. Run .\.venv\Scripts\python.exe -m mkdocs build --strict for docs/nav changes.
5. Record any unverified external dependency such as real Unity, real Web App, S3, FFmpeg/ffprobe, OpenSSL, or Windows service behavior.