Merged
Conversation
- field-annotation.mdx: replace non-existent @superdoc/field-annotation with SuperDoc constructor pattern - typescript-migration.mdx: @core/Extension → superdoc/super-editor - document-section.mdx: superdoc/extensions → superdoc/super-editor - template-builder quickstart + intro: superdoc/dist/style.css → superdoc/style.css
Wrap all fragment code snippets in superdoc/methods.mdx and supereditor/methods.mdx with CodeGroup Usage + Full Example tabs so every snippet is self-contained and runnable.
Adds scripts/validate-code-imports.js that scans all MDX files for JS/TS code blocks and validates import paths against an allowlist. Run with `pnpm run check:imports` from apps/docs.
![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: 880a0f9375
ℹ️ 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".
Wrap every code fragment across 36 extension doc pages with CodeGroup Usage/Full Example tabs so snippets are copy-pasteable.
Extracts "Full Example" code blocks from MDX files using remark/unified AST parsing, transforms them to run headlessly, and executes them against a real Editor instance to catch stale API references. Also fixes doc bugs caught by the tests: - overview.mdx: acceptAllChanges → acceptAllTrackedChanges - structured-content.mdx: add missing helper namespace
Replace regex state machine with remark-parse + remark-mdx AST walking. Convert from CJS to TypeScript, run with bun instead of node.
Add lefthook pre-commit hooks (docs-check-imports, docs-test-examples) that run when MDX files are staged. Update docs-validation CI workflow with import checking and doctest steps.
|
🎉 This PR is included in superdoc v1.11.0-next.23 The release is available on GitHub release |
|
🎉 This PR is included in superdoc v1.12.0-next.1 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.
No description provided.