Skip to content

docs(standards): update Prop Reference section in README files#200

Merged
halvaradop merged 5 commits intomasterfrom
docs/update-readme-files
Aug 6, 2025
Merged

docs(standards): update Prop Reference section in README files#200
halvaradop merged 5 commits intomasterfrom
docs/update-readme-files

Conversation

@halvaradop
Copy link
Owner

@halvaradop halvaradop commented Aug 6, 2025

Description

This pull request updates the README.md files to enhance clarity and usability for users and contributors.

Key improvements include:

  • Prop Reference updates:
    • Added a Description column to provide concise explanations for each prop.
    • Included detailed information on the Accepted values for each prop, improving developer understanding.
  • Added three new sections to the documentation:
    • About – Overview of the package/library.
    • License – Licensing details.
    • Contributing – Guidelines for contributing to the project.

These updates aim to make the documentation more complete, user-friendly, and professional.

Checklist

  • Added documentation.
  • The changes do not generate any warnings.
  • I have performed a self-review of my own code
  • All tests have been added and pass successfully

Notes

@halvaradop halvaradop merged commit cdd65e0 into master Aug 6, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from Backlog to Done in @halvaradop Aug 6, 2025
@halvaradop halvaradop deleted the docs/update-readme-files branch August 6, 2025 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant