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: migrate documentation to Nuxt UI #198

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

Conversation

BobbieGoede
Copy link
Member

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme or JSDoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to 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

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

@BobbieGoede BobbieGoede added the documentation Improvements or additions to documentation label May 31, 2024
@BobbieGoede BobbieGoede requested a review from Tahul May 31, 2024 14:55
@BobbieGoede BobbieGoede self-assigned this May 31, 2024
@Tahul
Copy link
Member

Tahul commented May 31, 2024

I have a Nuxt UI pro license; I'll put the key :)

You rock @BobbieGoede ; thank you so much

Copy link
Member

@Tahul Tahul left a 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 (?)

@BobbieGoede BobbieGoede force-pushed the feat/update-documentation branch from 16b3e22 to 9e6c87a Compare October 9, 2024 08:02
@BobbieGoede BobbieGoede changed the title [DRAFT] docs: migrate documentation to Nuxt UI docs: migrate documentation to Nuxt UI Oct 11, 2024
@BobbieGoede BobbieGoede marked this pull request as ready for review October 11, 2024 08:27
@BobbieGoede
Copy link
Member Author

@Tahul
To keep things moving I have actually disabled the animations that I previously added to the docs, the contents of the docs haven't been edited by much either.

I think it's worth merging this update first and make improvements separately to prevent blocking ourselves 😅

@BobbieGoede BobbieGoede force-pushed the feat/update-documentation branch from a48c7ef to bc1c259 Compare October 12, 2024 13:11
@BobbieGoede
Copy link
Member Author

@Tahul
I have no idea how Netlify works, do we (actually you 😂) need to make changes to the docs deployment for this PR to work or will merging this PR work and deploy as usual?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add code snippets for Presets
2 participants