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(core): Improve Documentation and Markdown Conventions #137

Merged

Conversation

FranzGB
Copy link
Contributor

@FranzGB FranzGB commented Jan 20, 2024

Hello, I appreciate the effort put into creating this fantastic library! I noticed a few typographical errors in the documentation and took the initiative to correct them. Additionally, I've implemented some best practices for Markdown formatting to enhance the readability and consistency of the documentation.

Here's a summary of the changes:

  • Corrected various typographical errors across the documentation.
  • Updated the documentation to adhere to recommended Markdown conventions.
  • Added a type test

Please take a look at these changes whenever you get a chance. Thank you!

@FranzGB FranzGB requested review from JoseLion and alejo0o January 20, 2024 14:18
@FranzGB FranzGB self-assigned this Jan 20, 2024
Copy link
Member

@JoseLion JoseLion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for helping with this! Everything looks great, but we intentionally don't want to use Prettier to automatically format the code. Can you please revert those formatting changes? Let me know if you have any questions 🙂

@FranzGB FranzGB requested a review from JoseLion January 27, 2024 15:12
Copy link
Member

@JoseLion JoseLion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you for helping with this 🎉

@JoseLion JoseLion changed the title Improve Documentation and Markdown Conventions docs(core): Improve Documentation and Markdown Conventions Feb 14, 2024
@JoseLion JoseLion merged commit 8674cec into stackbuilders:main Feb 14, 2024
4 checks passed
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.

2 participants