docs(dev): add dev:docs workflow for local SuperDoc development#2165
Open
lucbic wants to merge 2 commits intosuperdoc-dev:mainfrom
Open
docs(dev): add dev:docs workflow for local SuperDoc development#2165lucbic wants to merge 2 commits intosuperdoc-dev:mainfrom
lucbic wants to merge 2 commits intosuperdoc-dev:mainfrom
Conversation
Enable docs contributors to preview interactive widgets with local source changes. `pnpm dev:docs` starts the Vite dev server, UMD watcher, and Mintlify in parallel. - Refactor SuperDocEditor widget to load from local dev server on localhost - Add serve-dist-for-docs Vite plugin to serve UMD bundle over CORS - Add watch:umd script with debounced rebuilds (300ms) - Document the workflow in apps/docs/README.md
![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: 3d7387fb7f
ℹ️ 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".
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.
The problem
I was trying to fix a bug in the Image extension section of the docs, but I noticed that changes in the
packages/super-editorwere not being reflected in the docs local dev server.The idea
Instead of just fetching the superdoc bundle from unpkg, it detects if the user is running the docs in development and fetches the built files from the vite dev server. The file changes are watched to trigger new builds, which run instantaneously thanks to vite.
The feature
Enable docs contributors to preview interactive widgets with local source changes.
pnpm dev:docsstarts the Vite dev server, UMD watcher, and Mintlify in parallel.