From 81d2b84c7bf02c643326bbc99fa712be6b8435c2 Mon Sep 17 00:00:00 2001 From: donghyeon-ka Date: Sun, 27 Sep 2026 13:34:53 +0900 Subject: [PATCH] docs: correct drifted counts and state what verify:documentation checks (14-07) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The gate count and the reference-feature LOC table were hand-typed and drifted from the code, so they are removed; the LOC table now names the files and the command that measures them. .env.example pointed to layers.md for runtime profiles, which never described them; it now points to the README section that does. ci-quality-gates.md lists the three things DOCUMENTATION_READY checks, so the gate name is not read as a general documentation-accuracy guarantee. The route list (③) and the README config location (④) were already fixed by 14-03 and 13-15. Co-Authored-By: Claude Opus 5.5 --- .env.example | 2 +- README.md | 2 +- .../capability-consumer-experience.md | 17 +++++++++-------- docs/operations/ci-quality-gates.md | 13 ++++++++++++- 4 files changed, 23 insertions(+), 11 deletions(-) diff --git a/.env.example b/.env.example index cae5252d..47d62975 100644 --- a/.env.example +++ b/.env.example @@ -6,7 +6,7 @@ # Runtime configuration — API endpoints, auth mode, telemetry, capability # switches — is NOT here. It lives in `config/runtime/.json` and is # materialized into `dist/config.json` at build time, so it can be changed -# without rebuilding. See docs/architecture/layers.md. +# without rebuilding. See the "Runtime configuration" section of README.md. # # Copy to `.env.local` (git-ignored) to override locally. diff --git a/README.md b/README.md index 51ce9e84..f798dbe4 100644 --- a/README.md +++ b/README.md @@ -284,7 +284,7 @@ Live hosting verification (FE-GATE-019, production stage) requires ## CI and evidence -The 27-gate registry is `config/ci/gates.json`; the Gitea workflow is +The gate registry is `config/ci/gates.json`; the Gitea workflow is `.gitea/workflows/quality-gates.yml`. It follows: ```text diff --git a/docs/architecture/capability-consumer-experience.md b/docs/architecture/capability-consumer-experience.md index a214da6d..0d6761c0 100644 --- a/docs/architecture/capability-consumer-experience.md +++ b/docs/architecture/capability-consumer-experience.md @@ -15,15 +15,16 @@ The existing reference feature is the executable REST consumer. It covers list/detail/create behavior, mapping, typed operation inputs, application ports and an optimistic mutation path. -Current source size: +The feature-owned boundary and application source is these four files: -| Feature-owned area | LOC | -| --- | ---: | -| `application/reference-feature-api.ts` | 91 | -| `contracts/reference-mapper.ts` | 109 | -| `adapters/reference-http-gateway.ts` | 65 | -| `adapters/create-reference-feature-input.ts` | 41 | -| Total measured boundary/application source | 306 | +- `application/reference-feature-api.ts` +- `contracts/reference-mapper.ts` +- `adapters/reference-http-gateway.ts` +- `adapters/create-reference-feature-input.ts` + +This document does not keep their line counts; a hand-typed count drifted +from the code (review 14-07). Measure them with +`wc -l src/features/reference-feature/{application/reference-feature-api.ts,contracts/reference-mapper.ts,adapters/reference-http-gateway.ts,adapters/create-reference-feature-input.ts}`. The important boundary metric is not the raw total. It is what those files need to know about the platform. diff --git a/docs/operations/ci-quality-gates.md b/docs/operations/ci-quality-gates.md index dffabc88..0479abe7 100644 --- a/docs/operations/ci-quality-gates.md +++ b/docs/operations/ci-quality-gates.md @@ -1,6 +1,6 @@ # CI quality-gate orchestration -`config/ci/gates.json` is the executable registry for all 27 gates and the sole +`config/ci/gates.json` is the executable registry for every gate and the sole workflow model. `.gitea/workflows/quality-gates.yml` is generated from that strict v2 contract; it is not an independent configuration authority. Update the registry, run `corepack pnpm generate:ci-workflow`, and commit the generated @@ -115,6 +115,17 @@ MERGE_READY DOCUMENTATION_READY (off-chain) ``` +`DOCUMENTATION_READY`(`verify:documentation`)가 검사하는 범위는 좁다 +(`scripts/verify-documentation-readiness.ts`). + +- diagram 리뷰 ledger(`docs/architecture/review-ledger.json`)와 + `review-evidence.md`가 같은 경로·해시·점수를 담는지 +- README와 `docs/accessibility/manual-checklist.md`가 설치된 route ID를 모두 + 적는지 +- README가 빌드와 승인 단계가 읽는 환경 변수를 모두 적는지 + +문서의 다른 내용(수치, 목록, 설명)이 코드와 맞는지는 검사하지 않는다(리뷰 14-07). + `check:architecture`는 Babel parser/Node resolver 기반 `staticImportGraph`를 `artifacts/quality/dependency-report.json`에 기록한다. 규칙은 `.dependency-cruiser.json`에서 읽지만 dependency-cruiser는 실행하지 않는다.