Skip to content

docs: remove docs-utils and inline stringify function into demos #4710

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

OrbisK
Copy link
Collaborator

@OrbisK OrbisK commented Apr 14, 2025

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

This PR inlines the strigify function in every demo.vue. It then removes the docs-utils

Fixes #4705

@OrbisK
Copy link
Collaborator Author

OrbisK commented Apr 14, 2025

I will add the further todos in a follow up pr, so we can release this asap to get demos for #4702 working

@OrbisK OrbisK requested review from antfu and 43081j and removed request for antfu April 14, 2025 15:41
@OrbisK OrbisK marked this pull request as ready for review April 14, 2025 15:48
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Apr 14, 2025
43081j
43081j previously approved these changes Apr 18, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 18, 2025
ilyaliao
ilyaliao previously approved these changes Apr 19, 2025
@OrbisK OrbisK dismissed stale reviews from 43081j and ilyaliao via c4346fe May 6, 2025 10:05
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels May 6, 2025
@OrbisK OrbisK changed the title feat(internal-docs-utils): add @vueuse/internal-docs-utils package docs: remove docs-utils and inline stringify function into demos May 6, 2025
Comment on lines +17 to +21
"@vueuse/shared/*": ["./packages/shared/*"],
"@vueuse/components": ["./packages/components/index.ts"],
"@vueuse/components/*": ["./packages/components/*"],
"@vueuse/rxjs": ["./packages/rxjs/index.ts"],
"@vueuse/rxjs/*": ["./packages/rxjs/*"]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@antfu the typecheck of the components and rxjs imports needs this to be built.

Previously the demos imported from relative paths, so we never needed this. But maybe we dont want to add this 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TASK | prepare @vueuse/internal-docs-utils to be publisched
4 participants