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

docs: documentation and naming consistency fixes #12

Merged

Conversation

kamajus3
Copy link
Contributor

@kamajus3 kamajus3 commented Oct 1, 2023

Problems

  1. Naming Consistency: The primary class of the library, originally named "OtpInput," was inconsistently referred to as "OTPInput" in the documentation. This pull request standardizes the naming to "OtpInput" throughout the documentation for clarity and consistency.

  2. Documentation Structure Improvement: The documentation contained an error in the structure for configuring the component. Certain properties needed to be nested within the "theme" property to enhance organization and clarity. This pull request corrects the documentation structure, improving its readability and ease of use.

Proposed Changes:

  • Update references from "OTPInput" to "OtpInput" in the documentation.
  • Restructure the documentation example code to correctly group related properties within the "theme" object.

#11

@techieoriname
Copy link

Thank you @carl0smat3us.
Really nice, it's great effort put in so far.
There's actually more to just the documentation

@anday013
Copy link
Owner

anday013 commented Oct 6, 2023

@carl0smat3us nice catches! Thank you for your contribution!

@anday013 anday013 changed the title Documentation and Naming Consistency Fixes docs: documentation and naming Consistency Fixes Oct 6, 2023
@anday013 anday013 merged commit a86702f into anday013:main Oct 6, 2023
1 check passed
@anday013 anday013 changed the title docs: documentation and naming Consistency Fixes docs: documentation and naming consistency fixes Oct 6, 2023
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.

3 participants