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

Fixed #48 - Enhanced the readability of docs #49

Closed
wants to merge 3 commits into from

Conversation

Devmoni
Copy link
Contributor

@Devmoni Devmoni commented Mar 10, 2024

Fixed #48

The documentation text has been improved by making key points and headings bold for better visibility and importance. Additionally, text boxes have been utilized to highlight subpoints, enhancing readability.

Before :
3

After:
4

@CLAassistant
Copy link

CLAassistant commented Mar 10, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@aaronbrethorst aaronbrethorst left a comment

Choose a reason for hiding this comment

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

Thanks for investing what was undoubtedly a lot of time with this code change (or maybe you did a find-and-replace 🤷)

Either way, I am open to this change but please:

  1. Remove the extra newlines in index.js and index.css
  2. Modify the site's CSS instead of manually bolding every element. https://tailwindcss.com/docs/font-weight
  3. revert yarn.lock or explain why it changed

thanks!

@Devmoni
Copy link
Contributor Author

Devmoni commented Mar 10, 2024

Thank you very much for your guidance. I will proceed with making the required adjustments as per your instructions.

@Devmoni
Copy link
Contributor Author

Devmoni commented Mar 16, 2024

@aaronbrethorst Sir, I need your help with this PR.

I've attempted to apply Tailwind to Markdown files, but I've found that I need to use HTML tags in each file.

Additionally, I've added borders to the small headings in the Markdown files, but I'm unable to find a direct way to achieve this using Tailwind.

Not everywhere backticks are applied to make a border.

Could you please guide me on how to achieve this?

@aaronbrethorst
Copy link
Member

@Devmoni sorry but I don't have enough free time to help you with your PR. If you won't be able to complete it, I recommend closing the PR.

@aaronbrethorst
Copy link
Member

#105 took care of the last parts of this.

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.

fix: Inconsistency in documnetation text
3 participants