// Procedures for updating SceneScape documentation — where to make changes and what to update for each type of modification.
Runtime test verification gate for SceneScape — image freshness checks, rebuild-before-test requirements, and retry policy.
Guide for creating SceneScape test cases — unit, functional, integration, UI, and smoke tests with positive and negative cases.
JavaScript coding standards for SceneScape — code style, conventions, and frontend patterns.
Makefile standards for SceneScape — build targets, conventions, and patterns.
Python coding standards for SceneScape — imports, indentation, patterns, and conventions.
On-demand security review skill for SceneScape — code and configuration security guidance.
| name | documentation-how |
| description | Procedures for updating SceneScape documentation — where to make changes and what to update for each type of modification. |
For guidance on WHEN to update documentation, see the "Documentation Requirements (Always-On)" section in .github/copilot-instructions.md.
This guide covers the HOW: where to make changes and what to update for each type of modification.
docs/user-guide/microservices/<service>/<service>.md - Feature descriptions, API endpoints, usage examplesdocs/user-guide/microservices/<service>/get-started/build-from-source.md - Build steps, Makefile targets, Docker commands<service>/README.md - Quick start and high-level overview (if exists)docs/user-guide/microservices/<service>/**/_assets/*.yaml or api-reference.md - API specs/references for REST APIsdocs/user-guide/ - Cross-service documentation, architecture guidestests/README.md and service-specific test docs (for example mapping/tests/README.md) - Test setup and execution instructionsWhen making changes, verify and update:
build-from-source.md (include new targets)docs/user-guide/microservices/<service>/ directory structure<service>.md with feature descriptions and API endpointsget-started/build-from-source.md with build instructionsapi-reference.md and/or _assets/*.yaml) if applicabledocs/user-guide/ with cross-service documentation<service>.md).env snippetsbuild-from-source.md with configuration instructions_assets/*.yaml) or api-reference.md<service>.md) with new endpoints/parametersbuild-from-source.mddocs/user-guide/microservices/controller/controller.md): Scene management, object tracking, REST APIdocs/user-guide/microservices/controller/get-started/build-from-source.md): Makefile targets, Docker commandsdocs/user-guide/microservices/controller/api-reference.md and _assets/scene-controller-api.yaml): gRPC/REST endpoint definitionscontroller/tests/README.md): Unit, functional, integration test executiondocs/user-guide/using-intel-scenescape/ and related guides): Web UI features, REST API, database schemadocs/user-guide/get-started.md and root build guides): Django setup, migrations, static filesdocs/user-guide/api-reference.md): REST endpoint definitionsmanager/tests/README.md): UI tests, functional tests, API testsdocs/user-guide/microservices/auto-calibration/auto-calibration.md): Calibration algorithms, input/output formatsdocs/user-guide/microservices/auto-calibration/get-started/build-from-source.md): Build commands, dependenciesdocs/user-guide/microservices/auto-calibration/api-reference.md): REST API for calibration requestsRoot-level documentation in docs/user-guide/:
Update root documentation when: