fix(document-api): stop requiring alpha wording in overview check#3454
Merged
caio-pizzol merged 1 commit intoMay 22, 2026
Merged
Conversation
The Document API is live, not in alpha. `check-overview-alignment` was still requiring `/\balpha\b/i` and `/subject to (?:breaking )?changes?/i` in `apps/docs/document-api/available-operations.mdx`. That requirement landed in SD-3262 (#3453) when the API's docs explicitly described it as alpha. Commit 1154ede removed the alpha warning from the docs (API is now live), which broke `docapi:check` on main: the script fails because it expects launch-phase framing that the docs correctly no longer have. The fix is to retire the launch-phase requirements, not restore the warning. Per-PR gates should enforce durable structural correctness (reference link present, generated markers present, no stale placeholders, only known `editor.doc.*` paths). They should not force old product positioning back into the docs. Changes: - `check-overview-alignment.ts`: remove `alpha disclaimer` and `subject-to-change disclaimer` from `REQUIRED_PATTERNS`. Keep the `generated reference link` + generated-marker requirements, the forbidden-placeholders list, and the unknown-member-path detection. - Refresh the file header to describe what the gate actually enforces now, and call out that product-status framing is intentionally NOT enforced. - `packages/document-api/scripts/README.md`: update the script-index row description so it matches the new behavior (and the correct filename `available-operations.mdx`, not `overview.mdx`). Verified: `pnpm run docapi:sync:check` → exit 0 (parity 403; outputs 446; examples 5; overview 404 member paths).
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.
The Document API is live, not in alpha.
check-overview-alignmentwas still requiring/\balpha\b/iand/subject to (?:breaking )?changes?/iinapps/docs/document-api/available-operations.mdx. That requirement landed in SD-3262 (#3453) when the API's docs explicitly described it as alpha. Commit 1154ede removed the alpha warning from the docs (API is now live), which brokedocapi:checkon main: the script fails because it expects launch-phase framing that the docs correctly no longer have.The fix is to retire the launch-phase requirements, not restore the warning. Per-PR gates should enforce durable structural correctness; they should not force old product positioning back into the docs.
Changes:
check-overview-alignment.ts: removealpha disclaimerandsubject-to-change disclaimerfromREQUIRED_PATTERNS. Keep thegenerated reference link+ generated-marker requirements, the forbidden-placeholders list, and the unknown-member-path detection.packages/document-api/scripts/README.md: update the script-index row description to match the new behavior (and the correct filenameavailable-operations.mdx, notoverview.mdx).What's still enforced:
generated reference linkexists in the overview pagedoc.query(...),doc.table(...),field-annotationselector examples,coming sooncopy)editor.doc.*paths reference known API membersVerified:
pnpm run docapi:sync:check→ exit 0 (parity 403; outputs 446; examples 5; overview 404 member paths).docapi:checkis now green on main once this lands.After this merges, SD-3261 (retire
check-doc-coverage) resumes.