New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: typecheck code samples in docs #25777
Merged
Merged
Conversation
This file contains 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
Run & review this pull request in StackBlitz Codeflow. |
β Live Preview ready!
|
danielroe
reviewed
Feb 13, 2024
antfu
changed the title
docs: CI for verify types in docs
docs: enable CI for verifing types in docs
Feb 14, 2024
danielroe
approved these changes
Feb 15, 2024
danielroe
reviewed
Feb 15, 2024
Comment on lines
+35
to
+40
|
||
- name: Build Nuxt | ||
run: pnpm build | ||
|
||
- name: Typecheck (docs) | ||
run: pnpm typecheck:docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe there is an opportunity here to move docs workflow back into main ci.yml but use tj-actions/changed-files
instead to granularly enable workflows.
danielroe
changed the title
docs: enable CI for verifing types in docs
ci: typecheck code samples in docs
Feb 15, 2024
danielroe
force-pushed
the
docs/twoslash-verify
branch
from
February 15, 2024 09:54
2d4d0f6
to
44e5d66
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
π Linked issue
β Type of change
π Description
This PR adds typecheck for TwoSlash blocks in our docs Markdown. Follow up on #25679 to make it easier to work with without linking to nuxt.com repo. This would help us provide code examples that are type-safe in the future.
π Checklist