docs(document-api): wire check-overview-alignment + add status disclaimers (SD-3262)#3453
Merged
caio-pizzol merged 2 commits intoMay 22, 2026
Conversation
…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.
caio-pizzol
merged commit 506e5e2
into
caio-pizzol/SD-673-phase2-docapi-orphans
4 of 5 checks passed
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
1 participant
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.
Closes SD-3262.
check-overview-alignment.tswas failing onmainbecauseapps/docs/document-api/available-operations.mdxwas missing two required disclaimers (the script checks for/\balpha\b/iand/subject to (?:breaking )?changes?/i). SD-673 Phase 2 deferred this to a follow-up because the check was blocked by content drift.Changes:
Add a
<Warning>block at the top ofavailable-operations.mdx:Honest customer-facing copy (not boilerplate to satisfy the script) and satisfies both required patterns.
Wire
check-overview-alignmentintodocapi:check. The chain is now:parity → outputs → examples → overview-alignment.Update
packages/document-api/scripts/README.md: movecheck-overview-alignmentfrom "blocked by drift" to "Per-PR (wired)".check-doc-coveragestays 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 the SD-673 Phase 0 audit) referred to
overview.mdx. The script actually readsapps/docs/document-api/available-operations.mdx; the constantOVERVIEW_PATHinlib/reference-docs-artifacts.tspoints there. This PR edits the correct file.Stacks on #3452 (SD-673 Phase 2). After both merge,
docapi:checkgates 4 sub-checks; the only remaining orphan ischeck-doc-coverageunder SD-3261.Verified:
pnpm run docapi:sync:check→ exit 0 (parity: 403 ops; outputs: 446 files; examples: 5 found; overview: 404 member paths).