Skip to content
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

docs: fix inconsistencies, remove low informative twoslash examples #6200

Merged
merged 7 commits into from
Jul 23, 2024

Conversation

sheremet-va
Copy link
Member

@sheremet-va sheremet-va commented Jul 23, 2024

Description

This PR removes almost all twoslash examples from docs. I left only those that give at least some useful information:

  • show error that reports is not available in the workspace project
  • show the power of vi.mock with import
  • show hover information on expect example (this is also low on information, but it's good to showcase it at least once)

This saves time and memory during build.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@sheremet-va sheremet-va changed the title docs: fix inconsistencies, add more twoslash examples docs: fix inconsistencies, remove low informative twoslash examples Jul 23, 2024
Copy link

netlify bot commented Jul 23, 2024

Deploy Preview for vitest-dev ready!

Name Link
🔨 Latest commit 405a629
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/669f98ad4125400008b6057b
😎 Deploy Preview https://deploy-preview-6200--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sheremet-va sheremet-va merged commit 57d23ce into vitest-dev:main Jul 23, 2024
16 checks passed
@sheremet-va sheremet-va deleted the docs/improve-twoslash branch July 23, 2024 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant