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

Add Documentation for Component Usage #5

Open
HannesAlexandersson opened this issue Aug 31, 2024 · 0 comments
Open

Add Documentation for Component Usage #5

HannesAlexandersson opened this issue Aug 31, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@HannesAlexandersson
Copy link
Owner

Good First Issue: Improve Documentation for Components

Description

We need to improve the documentation for the exampleButton component to make it clearer for new users. This includes adding examples of different usage scenarios and ensuring the README files are up-to-date.

Task

  • Review the README.md file located in /components/Buttons/exampleButton/.
  • Add additional usage examples.
  • Ensure all instructions are clear and accurate.
  • Update any outdated or missing information.

Why This is Important

Improving the documentation helps new contributors and users understand how to use the component effectively, which is crucial for increasing engagement with the project.

How to Get Started

  1. Fork the repository and clone it locally.
  2. Navigate to the components/Buttons/exampleButton/ directory.
  3. Edit the README.md file to include the necessary improvements.
  4. Test your changes locally by viewing the documentation in a browser.
  5. Create a pull request with your changes.

Resources

Additional Notes

Feel free to ask any questions if you need help or clarification. We’re here to support new contributors!

@HannesAlexandersson HannesAlexandersson added good first issue Good for newcomers documentation Improvements or additions to documentation labels Aug 31, 2024
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant