[AZ-485] [AZ-486] Cycle 1 docs refresh (Step 13)
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>
This commit is contained in:
Oleksandr Bezdieniezhnykh
2026-05-12 00:01:04 +03:00
parent 8a461a2051
commit 17d5bb45e7
17 changed files with 456 additions and 172 deletions
+19 -48
View File
@@ -2,57 +2,28 @@
## Current Step
flow: existing-code
step: 10
name: Implement
status: in_progress
step: 16
name: Deploy
status: not_started
sub_step:
phase: 7
name: batch-10-cycle1-az486-complete
detail: "AZ-486 (F7 endpoint builders + STC-ARCH-02) implemented + reviewed; batch_10_report saved; archive done; awaiting user approval to commit and then auto-chain to Step 11"
phase: 0
name: awaiting-invocation
detail: ""
retry_count: 0
cycle: 1
tracker: jira
step_4_5_glossary_vision: confirmed
step_2_baseline_routing: per-finding-recommended (option A)
step_3_results_report_authoring: agent (option A)
step_3_ac_gap_handling: rollback-to-6c (option A)
## Notes
- Phase A baseline cycle. Step 1 (Document) complete; see
`_docs/02_document/state.json`, `FINAL_report.md`, `architecture.md`,
`glossary.md`, plus `_docs/01_solution/solution.md` and
`_docs/00_problem/{problem,acceptance_criteria,restrictions,security_approach}.md`.
- Implement-skill batch reports at
`_docs/03_implementation/batch_0{1..9}_report.md` + `batch_10_report.md`
(batch 09 = AZ-485 cycle-1 batch-1; batch 10 = AZ-486 cycle-1 batch-2).
- Cumulative reviews PASS_WITH_WARNINGS at
`_docs/03_implementation/cumulative_review_batches_01-03_report.md`,
`_docs/03_implementation/cumulative_review_batches_04-06_cycle1_report.md`,
`_docs/03_implementation/cumulative_review_batches_07-08_cycle1_report.md`
(cycle close — Phase A wrap, no batch 9).
- Phase B cycle 1 closed (2 batches, both AC + static + fast green):
- AZ-485 (F4 — Public API barrels + STC-ARCH-01, 5 pts) — committed 23746ec
- AZ-486 (F7 — Endpoint builders + STC-ARCH-02, 5 pts) — batch 10 done,
uncommitted, awaiting user approval.
- Step 10 (Implement) batch 10 (AZ-486) done:
- 2 new files (`src/api/endpoints.ts` 25 builders, `src/api/endpoints.test.ts` 36 cases).
- 1 barrel update (`src/api/index.ts` re-exports `endpoints`).
- 13 production files migrated to `endpoints.*` (admin, annotations,
flights, settings, dataset, auth, client, FlightContext,
DetectionClasses, CanvasEditor, VideoPlayer, MediaList,
AnnotationsSidebar, AnnotationsPage).
- `scripts/check-arch-imports.mjs` extended with `--mode=api-literals`
(STC-ARCH-02) alongside `--mode=arch-imports` (STC-ARCH-01);
`scripts/run-tests.sh` wires both modes.
- `tests/architecture_imports.test.ts` extended with 6 STC-ARCH-02 cases
(single/double/template-literal fail paths, *.test.* exemption,
line-comment skip, migrated-codebase pass).
- `_docs/02_document/module-layout.md` `01_api-transport` Public API now
lists `endpoints`; Verification Needed item #3a records F7 resolution.
- Test counts: 167 → 209 PASS / 13 SKIP / 0 FAIL (+42).
- Static: 31 / 31 PASS including new STC-ARCH-02.
- Cumulative code review (K=3): no trigger — Phase B cycle 1 had only 2
batches (9, 10).
- Next on commit of batch 10: auto-chain to Step 11 (Run Tests) via
`test-run/SKILL.md`. Final cycle-1 implementation report (`implementation_report_phase_b_cycle1.md`) is written at that point per
implement skill Step 16 handoff rule.
- Cycle 1 (Phase B) refactor cycle: F4 (AZ-485, `23746ec`) and F7
(AZ-486, `8a461a2`) closed.
- Step 13 (Update Docs) DONE in working tree, NOT YET COMMITTED. User
skipped the commit gate; 12 module docs + new `src__api__endpoints.md`
+ `01_api-transport/description.md` + ripple log + 2 cycle reports
pending review. Commit subject for when ready:
`[AZ-485] [AZ-486] Cycle 1 docs refresh (Step 13)`.
- Step 14 (Security Audit) SKIPPED — cycle 1 was structural refactor
only; URL strings character-identical to pre-refactor (pinned by
`endpoints.test.ts`), no new auth / wire / permission surface.
- Step 15 (Performance Test) SKIPPED — same rationale; no
latency-/throughput-relevant code paths changed.
- Next: Step 16 (Deploy) — destructive; awaiting user decision.