-
-
Notifications
You must be signed in to change notification settings - Fork 79
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
[DRAFT] docs: migrate documentation to Nuxt UI #198
Draft
BobbieGoede
wants to merge
12
commits into
vueuse:main
Choose a base branch
from
BobbieGoede:feat/update-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
I have a Nuxt UI pro license; I'll put the key :) You rock @BobbieGoede ; thank you so much |
Tahul
reviewed
Jun 1, 2024
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.
looks really neat :)
have some steps in mind before merging:
- rephrase blocks to make it simpler
- animate every element (blocks as well as headings and illustration)
- split docs/ into 3 different root sections (Get Started, Features, API)
- maybe change the default animation settings for presets & examples, looks a bit too quick (?)
9 tasks
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
Resolves #114
Thanks to the amazing work by @MuhammadM1998 on updating Nuxt I18n's docs (nuxt-modules/i18n#2740) I had good reference for doing the same on the docs here (thanks again!).
Most of the pages remain unchanged, mostly the presets page and the main page have updates. @Tahul if you have some ideas on spicing up the main/homepage (it's a bit incomplete currently) let me know or feel free to commit to this branch.
Also, this uses Nuxt UI Pro, I'm not sure what steps are required to make deployment and such work 🤷♂️
📝 Checklist