Skip to content

docs(document-api): wire check-overview-alignment + add status disclaimers (SD-3262) #3453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caio-pizzol merged 2 commits into from
May 22, 2026
+3 −3
Merged

docs(document-api): wire check-overview-alignment + add status disclaimers (SD-3262) #3453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d1fc42
docs(document-api): wire check-overview-alignment + add status discla…
caio-pizzol May 22, 2026
1154ede
chore: alpha warning
caio-pizzol May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"generate:all": "node scripts/generate-all.mjs",
"docapi:all": "pnpm run generate:all && pnpm exec tsc -b packages/document-api && pnpm --prefix apps/cli run build && pnpm --prefix packages/sdk run build:node",
"docapi:sync": "pnpm exec tsx packages/document-api/scripts/generate-contract-outputs.ts",
"docapi:check": "pnpm exec tsx packages/document-api/scripts/check-contract-parity.ts && pnpm exec tsx packages/document-api/scripts/check-contract-outputs.ts && pnpm exec tsx packages/document-api/scripts/check-examples.ts",
"docapi:check": "pnpm exec tsx packages/document-api/scripts/check-contract-parity.ts && pnpm exec tsx packages/document-api/scripts/check-contract-outputs.ts && pnpm exec tsx packages/document-api/scripts/check-examples.ts && pnpm exec tsx packages/document-api/scripts/check-overview-alignment.ts",
"docapi:sync:check": "pnpm run docapi:sync && pnpm run docapi:check",
"test:cli": "pnpm --prefix apps/cli run test",
"cli:prepare": "pnpm run test:cli && pnpm --prefix apps/cli run build:prepublish",
Expand Down
4 changes: 2 additions & 2 deletions packages/document-api/scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Three buckets:

| Bucket | Scripts | Notes |
| --- | --- | --- |
| **Per-PR (wired into `docapi:check`)** | `check-contract-parity`, `check-contract-outputs`, `check-examples` | Run on every doc-api PR via `ci-document-api.yml`. |
| **Per-PR (wired into `docapi:check`)** | `check-contract-parity`, `check-contract-outputs`, `check-examples`, `check-overview-alignment` | Run on every doc-api PR via `ci-document-api.yml`. |
| **Focused / manual** | `check-stable-schemas`, `check-agent-artifacts`, `check-generated-reference-docs` | Targeted local-debug variants of `check-contract-outputs` (the per-PR superset). Useful when iterating on one artifact area without re-running the full superset. Not wired into CI by design. |
| **Per-PR intent, blocked by drift** | `check-doc-coverage`, `check-overview-alignment` | Designed as docs-quality gates but currently fail on `main` due to pre-existing content drift. Tracked separately; wire after the drift is fixed. |
| **Per-PR intent, blocked by design question** | `check-doc-coverage` | Currently reports 348 missing operation README sections. The binary check may be enforcing the wrong rule (per-operation README sections vs generated reference docs). Tracked in SD-3261; needs a docs-model decision before wiring. |

## Manual vs generated boundaries

Expand Down
Loading