search

Git21221 / form-snippet

A simple form that made on top of MUI components and uses react hook form for validation.
https://www.npmjs.com/package/form-snippet
MIT License
5 stars 14 forks source link

ADD TABLE OF CONTENT ON README FILE #37

Closed alo7lika closed 1 month ago

alo7lika commented 1 month ago

Describe the bug A clear and concise description of what the bug is: Table of contents and API documentation are missing in the README file, which makes navigating and understanding the project more difficult for new users.

To Reproduce Steps to reproduce the behavior:

  1. Go to the repository's README file.
  2. Look for the Table of Contents or API documentation section.
  3. Scroll through the file to confirm the absence of these sections.
  4. See error.

Expected behavior The README should include a well-structured Table of Contents and detailed API documentation to help users and contributors easily navigate the file and understand the project.

Screenshots No screenshots applicable.

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context The lack of documentation reduces the accessibility and ease of use of the project. Adding a Table of Contents and API documentation would improve the user experience.

github-actions[bot] commented 1 month ago

👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!

alo7lika commented 1 month ago

ADD LABELS GSSOC EXT 24 AND HACKTOBERFEST ASSIGN ME THE TASK @Git21221 THANK YOU!

Git21221 commented 1 month ago

@alo7lika you can add table of contents, for your more information you can check original documentation of this package docs: https://docs-form-snippet.vercel.app/docs we don't need to document all in readme just the starting part and Input and Button component should be fine and there is no API documentation needed.

alo7lika commented 1 month ago

@alo7lika you can add table of contents, for your more information you can check original documentation of this package docs: https://docs-form-snippet.vercel.app/docs we don't need to document all in readme just the starting part and Input and Button component should be fine and there is no API documentation needed.

OK, ADD LABELS GSSOC EXT 24 AND HACKTOBERFEST HERE ON THE ISSUE @Git21221