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

fix(docs): Correct useInView docs ,simplify build and add image to readme for better branding #63

Merged
merged 7 commits into from
Feb 2, 2025

Conversation

ketsebaoteth
Copy link
Contributor

Improve Documentation and Add Logo

This pull request addresses several documentation issues and enhances the README with a logo.

Key Changes:

  • CONTRIBUTING.md: Added instructions on how to build the documentation locally.
  • README.md:
    • Added the Motion-Vue logo with the text "Motion-Vue".
  • docs/useInView: Corrected the documentation for the useInView hook. It now accurately states that the hook returns a ref to a boolean. saying it returns a boolean could be confusing
  • Documentation Build: Modified the documentation build process to no longer require execa.

Motivation:

These changes aim to improve the overall developer experience by:

  • Making the contribution process smoother.
  • Enhancing the README with a visual element.
  • Ensuring the accuracy of the documentation.
  • Simplifying the documentation build process.

Testing:

  • Verified that the documentation builds locally without errors.
  • Confirmed the correct behavior of the useInView hook.
  • Checked the display of the logo in the README.

@rick-hup
Copy link
Collaborator

rick-hup commented Feb 2, 2025

thanks for the contribution !

@rick-hup rick-hup merged commit 6921c5b into motiondivision:master Feb 2, 2025
0 of 2 checks passed
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.

2 participants