chore(ai): deprecate @superdoc-dev/ai - #2939
Merged
Merged
Conversation
Mark packages/ai/package.json as private and strip publish/release scripts so the package can never be accidentally republished. Add a deprecation banner to packages/ai/README.md pointing users at @superdoc-dev/mcp and @superdoc-dev/sdk with the Document API. Delete the already-hidden apps/docs/ai/ai-actions/ pages and remove @superdoc-dev/ai entries from apps/docs/scripts/validate-code-imports.ts and apps/docs/__tests__/lib/extract.ts so the docs stop advertising (and stop lint-allowing) a deprecated package. Run npm deprecate '@superdoc-dev/ai@*' '<message>' alongside merging this PR to emit install-time warnings for existing consumers. Full source removal (rm -rf packages/ai, pnpm-workspace.yaml entry, eval references, scripts/type-check-all and scripts/test-cov entries) is tracked as a separate cleanup PR.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5fd6abd585
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
ai-builder/overview.mdx only existed to link to the now-deleted ai-actions docs and was already hidden from navigation. Remove the page and drop the corresponding skip pattern from the docs test extract helper so no broken internal links remain.
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.
Formally deprecate
@superdoc-dev/ai. Prior PR (#2938) already stripped it from CI and release triggers; this one stops it from being published again and removes it from the docs surface so users stop being pointed at a package that will warn on install.packages/ai/package.json→"private": true, publish/release scripts removed.packages/ai/README.md→ deprecation banner pointing at@superdoc-dev/mcpand@superdoc-dev/sdkwith the Document API.apps/docs/ai/ai-actions/→ deleted (already hidden from Mintlify nav indocs.json, so no user-visible routing change).apps/docs/scripts/validate-code-imports.tsandapps/docs/__tests__/lib/extract.ts→ drop@superdoc-dev/aifrom the allowlist and/ai\/ai-actions\//from the skip-file patterns.Registry state at the time of writing:
latest: 0.1.6,next: 0.1.8-next.6. Neither is flagged deprecated. Run this command alongside merging:```bash
npm deprecate '@superdoc-dev/ai@*' 'Deprecated: @superdoc-dev/ai is no longer maintained. Use @superdoc-dev/mcp or @superdoc-dev/sdk with the SuperDoc Document API.'
```
Full source removal (
rm -rf packages/ai,pnpm-workspace.yamlentry, eval references,scripts/type-check-all.mjs,scripts/test-cov.mjs,vitest.config.mjs) is a separate cleanup PR once this has soaked.Verified:
pnpm install --frozen-lockfilesucceeds. Package still builds in-repo (scripts retainbuild,dev,test,lint) for any consumer of the workspace dep locally.