mirror of
https://github.com/azaion/ui.git
synced 2026-06-21 13:41:12 +00:00
Oleksandr Bezdieniezhnykh
17d5bb45e7
ci/woodpecker/push/build-arm Pipeline was successful
Phase B cycle 1 was a structural refactor only: F4 (barrel imports + STC-ARCH-01) and F7 (endpoint builders + STC-ARCH-02). This commit brings docs in line with source after the cycle, no code changes. Module docs (12 consumers): swap every /api/<service>/... literal in code snippets and integration tables for the matching endpoints.* builder; note the barrel import migration in Dependencies. New module doc: src__api__endpoints.md (public surface, F4 barrel re-export note, STC-ARCH-02 enforcement, contract-test reference). Architecture compliance baseline: mark F4 + F7 CLOSED with commit hashes (23746ec,8a461a2). 01_api-transport component description: add endpoints.ts + barrel to Internal Interfaces, close the F7 caveat, extend Module Inventory. ripple_log_cycle1.md: Task Step 0.5 reverse-dep analysis records the import-graph closure (no extra docs needed beyond the direct set). Carry-over reports landed alongside the docs: - test_run_report_phase_b_cycle1.md (Step 11 outcome) - implementation_report_refactor_phase_b_cycle1.md (cycle summary) State file: trimmed to the autodev <30-line target; Steps 14 + 15 recorded as SKIPPED with rationale (no security or perf surface changed in this cycle); pointer moved to Step 16 (Deploy). Co-authored-by: Cursor <cursoragent@cursor.com>
47 lines
3.7 KiB
Markdown
47 lines
3.7 KiB
Markdown
# Documentation Ripple Log — Cycle 1 (Phase B)
|
|
|
|
> Generated during Step 13 (Update Docs) of the autodev existing-code flow, cycle 1 (refactor-only).
|
|
> Task specs in scope: `AZ-485_phase_b_barrel_files.md`, `AZ-486_refactor_endpoint_builders.md` (both in `_docs/02_tasks/done/`).
|
|
|
|
## Scope analysis (Task Step 0)
|
|
|
|
Direct source files changed by Cycle 1 batches 9 + 10:
|
|
|
|
| Source file | Changed in | Touched module doc |
|
|
|---|---|---|
|
|
| `src/api/client.ts` | AZ-485 + AZ-486 | `modules/src__api__client.md` |
|
|
| `src/api/sse.ts` | AZ-485 | `modules/src__api__sse.md` |
|
|
| `src/api/endpoints.ts` (NEW) | AZ-486 | `modules/src__api__endpoints.md` (NEW) |
|
|
| `src/api/index.ts` (barrel) | AZ-485 + AZ-486 | covered in `components/01_api-transport/description.md` §2 |
|
|
| `src/auth/AuthContext.tsx` | AZ-486 | `modules/src__auth__AuthContext.md` |
|
|
| `src/components/FlightContext.tsx` | AZ-486 | `modules/src__components__FlightContext.md` |
|
|
| `src/components/DetectionClasses.tsx` | AZ-486 | `modules/src__components__DetectionClasses.md` |
|
|
| `src/features/admin/AdminPage.tsx` | AZ-486 | `modules/src__features__admin__AdminPage.md` |
|
|
| `src/features/settings/SettingsPage.tsx` | AZ-486 | `modules/src__features__settings__SettingsPage.md` |
|
|
| `src/features/dataset/DatasetPage.tsx` | AZ-486 | `modules/src__features__dataset__DatasetPage.md` |
|
|
| `src/features/flights/FlightsPage.tsx` | AZ-486 | `modules/src__features__flights.md` (group doc) |
|
|
| `src/features/annotations/{AnnotationsPage,AnnotationsSidebar,CanvasEditor,MediaList,VideoPlayer}.tsx` | AZ-486 | `modules/src__features__annotations.md` (group doc) |
|
|
|
|
System-level docs (`system-flows.md`, `data_model.md`, `architecture.md`): **not touched** — cycle 1 was a pure structural refactor (import paths + URL-literal centralisation). No flow diagrams, no entity shapes, no integration patterns changed.
|
|
|
|
Problem-level docs: **not touched** — cycle 1 introduced no new product acceptance criteria, no new input parameters, no new restrictions.
|
|
|
|
## Import-graph ripple (Task Step 0.5)
|
|
|
|
The reverse-dependency set of the changed files is **already captured in the direct list above**. Specifically:
|
|
|
|
- `src/api/index.ts` (barrel) is imported by every consumer module that uses `api`, `endpoints`, `createSSE`, `setToken`, `getToken`. After AZ-485 those imports moved to the barrel; after AZ-486 they additionally pulled in `endpoints`. The barrel itself has no separate module doc — its public surface is enumerated in `components/01_api-transport/description.md` §2.
|
|
- `src/api/endpoints.ts` is imported by `src/api/client.ts` (for the internal `refreshToken()` helper) and by every consumer module already in the direct list. No additional ripple.
|
|
- `src/api/client.ts` is imported by the consumer modules already in the direct list; no further ripple.
|
|
|
|
Therefore: **no additional doc was added to the refresh set by ripple analysis**. The direct file set is closed under the import graph.
|
|
|
|
## Tooling notes
|
|
|
|
- Ripple analysis was performed by reading `src/api/index.ts` and the changed files directly, plus the existing `_docs/02_document/components/01_api-transport/description.md` "Downstream consumers" enumeration. The repo has no `madge` / `depcruise` configured; this counts as the "directory-proximity + manual import inspection" fallback path from `document/workflows/task.md` Task Step 0.5 #6 — but with full coverage of the import graph because the changed file set is small.
|
|
- No static analyzer was used to discover indirect importers. None was needed: the consumer set of `src/api/index.ts` is small and already enumerated in `01_api-transport/description.md`.
|
|
|
|
## Outcome
|
|
|
|
All 12 affected module docs + 1 component doc + 1 NEW module doc updated in-place. Refresh set is complete.
|