chore(types): classify doc-api check scripts and wire check-examples (SD-673 Phase 2)#3452
Merged
Merged
Conversation
…(SD-673 Phase 2) Disposes the 6 doc-api check scripts that the Phase 0 audit flagged as "orphan" (not wired into CI). Reading the existing `packages/document-api/scripts/README.md` reframes the picture: three of the six are intentionally documented as focused local-debug variants of `check-contract-outputs` (the per-PR superset). One is genuinely missing from the wired chain. Two are intended as per-PR gates but blocked by pre-existing content drift on main. Phase 2 makes the classification explicit: - **Per-PR (wired into `docapi:check`)**: `check-contract-parity`, `check-contract-outputs`, **`check-examples`** (newly wired here; passes on main, low-cost, ensures workflow example headings stay documented in `src/README.md`). - **Focused / manual**: `check-stable-schemas`, `check-agent-artifacts`, `check-generated-reference-docs`. Targeted local-debug variants of `check-contract-outputs`. Not wired into CI by design (the superset already covers their failure modes). Status was already in the scripts README; this PR makes the "not in CI by design" framing explicit. - **Per-PR intent, blocked by drift**: `check-doc-coverage` (5 missing operation sections in `src/README.md`), `check-overview-alignment` (missing alpha + subject-to-change disclaimers in `apps/docs/document-api/overview.mdx`). Wire after the drift is fixed. Follow-ups: SD-3261, SD-3262. Net change: - `docapi:check` now runs 3 scripts (was 2): parity + outputs + examples. - `packages/document-api/scripts/README.md` gains a "Which checks run where" section so the disposition is visible at the call site. - No deletions; no script removals. The "focused" ones stay as documented local-debug tools. Stacks on #3450 (Phase 1 CI wiring). After #3450 merges and this lands, "is the doc-api contract healthy?" has exactly one CI-wired command (`docapi:check`) covering parity + outputs + examples. Verified: `pnpm run docapi:check` → exit 0 (parity: 403 ops; outputs: 446 files; examples: 5 found).
Base automatically changed from
caio-pizzol/SD-673-phase1-check-public-contract-ci
to
main
May 22, 2026 17:41
…imers (SD-3262) `check-overview-alignment.ts` was failing on `main` because the `apps/docs/document-api/available-operations.mdx` page was missing two required disclaimers (the script checks for `/\balpha\b/i` and `/subject to (?:breaking )?changes?/i`). SD-673 Phase 2 deferred this to a follow-up because it was blocked by content drift. Changes: - Add a `<Warning>` block at the top of `available-operations.mdx`: "Status: alpha. The Document API surface is stabilizing but is still subject to breaking changes between minor versions. Pin a version when integrating, and review the changelog before upgrading." Honest customer-facing copy (not boilerplate to satisfy the script) and satisfies both required patterns. - Wire `check-overview-alignment` into `docapi:check`. The chain is now: parity → outputs → examples → overview-alignment. - Update `packages/document-api/scripts/README.md`: move `check-overview-alignment` from "blocked by drift" to "Per-PR (wired)". `check-doc-coverage` stays in the "blocked" bucket but the framing is now "blocked by design question" with a pointer to SD-3261 (rescoped after the original 5-op drift turned out to be 348 ops; needs a docs-model decision before wiring). Note on file path: the original SD-3262 description (and SD-673 Phase 0 audit) referred to `overview.mdx`. The script actually reads `apps/docs/document-api/available-operations.mdx`; the constant `OVERVIEW_PATH` in `lib/reference-docs-artifacts.ts` points there. This PR edits the correct file. Stacks on #3452 (SD-673 Phase 2). After both merge, `docapi:check` gates 4 sub-checks; the only remaining orphan is `check-doc-coverage` under SD-3261. Verified: `pnpm run docapi:sync:check` → exit 0 (parity 403; outputs 446; examples 5; overview 404 member paths).
Removed alpha status warning from the Document API documentation.
…ew-disclaimers docs(document-api): wire check-overview-alignment + add status disclaimers (SD-3262)
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
|
🎉 This PR is included in superdoc-cli v0.12.0 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc-sdk v1.11.0 |
Contributor
|
🎉 This PR is included in @superdoc-dev/mcp v0.7.0 The release is available on GitHub release |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Disposes the 6 doc-api check scripts that the Phase 0 audit flagged as not wired into CI. Reading
packages/document-api/scripts/README.mdreframes the picture: three of the six are intentionally documented as focused local-debug variants ofcheck-contract-outputs(the per-PR superset). One was genuinely missing from the wired chain. Two are intended as per-PR gates but blocked by pre-existing drift on main.Classification:
docapi:check)check-contract-parity,check-contract-outputs,check-examplescheck-examplescheck-stable-schemas,check-agent-artifacts,check-generated-reference-docscheck-contract-outputs(already wired) covers their failure modes; these stay as targeted local-debug entry points.check-doc-coverage,check-overview-alignmentNet change:
docapi:checknow runs 3 scripts (was 2): parity + outputs + examplespackages/document-api/scripts/README.mdgains a "Which checks run where" section so the disposition is visible at the call siteStacks on #3450 (Phase 1). Together they make "is the public contract healthy?" → one CI-wired command per surface (
check:public-contractfor superdoc;docapi:checkfor doc-api).Verified:
pnpm run docapi:check→ exit 0 (parity: 403 ops; outputs: 446 files; examples: 5 found).