Documentation Update Procedures

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.

Documentation Locations by Component

Service Overview: docs/user-guide/microservices/<service>/<service>.md - Feature descriptions, API endpoints, usage examples
Build Instructions: docs/user-guide/microservices/<service>/get-started/build-from-source.md - Build steps, Makefile targets, Docker commands
Service README: <service>/README.md - Quick start and high-level overview (if exists)
API Specifications: docs/user-guide/microservices/<service>/**/_assets/*.yaml or api-reference.md - API specs/references for REST APIs
Root Documentation: docs/user-guide/ - Cross-service documentation, architecture guides
Testing Guide: tests/README.md and service-specific test docs (for example mapping/tests/README.md) - Test setup and execution instructions

When making changes, verify and update: