azaion/gps-denied-onboard

Fork 0

mirror of https://github.com/azaion/gps-denied-onboard.git synced 2026-06-22 21:51:12 +00:00

Files

T

Oleksandr Bezdieniezhnykh 1f634c2604

ci/woodpecker/push/02-build-push Pipeline failed

Details

Update demo replay validation and testing documentation

- Modified the autodev state to reflect the current testing phase and details of the new `jetson-e2e` tests.
- Enhanced the "How to Test" documentation to provide clearer instructions on the demo replay validation process, including video and tlog alignment steps.
- Updated architectural documentation to include the new demo replay operator flow and its dependencies.
- Documented the removal of deprecated auto-sync features and clarified the operator-facing UI for replay validation.
- Added new entries in the dependencies table for upcoming tasks related to the demo replay flow.

These changes improve clarity and usability for operators and developers working with the demo replay system.

2026-06-20 11:24:43 +03:00

2.4 KiB

Raw Blame History

Phase 7: Documentation Update

Role: Technical writer Goal: Update existing _docs/ artifacts to reflect all changes made during refactoring Constraints: Documentation only — no code changes. Only update docs that are affected by refactoring changes.

Skip condition: If no _docs/02_document/ directory exists, skip this phase entirely.

7a. Identify Affected Documentation

Review RUN_DIR/execution_log.md to list all files changed during Phase 4
Review test changes from Phase 5
Map changed files to their corresponding module docs in _docs/02_document/modules/
Map changed modules to their parent component docs in _docs/02_document/components/
Determine if system-level docs need updates (architecture.md, system-flows.md, data_model.md)
Determine if test documentation needs updates (_docs/02_document/tests/)

7b. Update Module Documentation

For each module doc affected by refactoring changes:

Re-read the current source file
Update the module doc to reflect new/changed interfaces, dependencies, internal logic
Remove documentation for deleted code; add documentation for new code

7c. Update Component Documentation

For each component doc affected:

Re-read the updated module docs within the component
Update inter-module interfaces, dependency graphs, caveats
Update the component relationship diagram if component boundaries changed

7d. Update System-Level Documentation

If structural changes were made (new modules, removed modules, changed interfaces):

Update _docs/02_document/architecture.md if architecture changed — but never edit the ## Architecture Vision section. That section is user-confirmed (plan Phase 2a.0 / document Step 4.5); if a refactor invalidates a vision principle, surface it to the user and let them update the vision themselves before continuing. Update only the technical sections below the Vision H2.
Update _docs/02_document/system-flows.md if flow sequences changed
Update _docs/02_document/diagrams/components.md if component relationships changed

Self-verification:

Every changed source file has an up-to-date module doc
Component docs reflect the refactored structure
No stale references to removed code in any doc
Dependency graphs in docs match actual imports

Save action: Updated docs written in-place to _docs/02_document/

2.4 KiB Raw Blame History