HannesAlexandersson / HannesAlexandersson/Simple-web-components-library

Add Documentation for Component Usage

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
CSS
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## 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
- [Markdown Guide](https://www.markdownguide.org/)
- [How to Fork a Repo](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-forks)

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.