Docs: fix typo, improve readability, add code comments #7796

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.

Sign up for GitHub

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

Jump to bottom

Open

tanisha-samant wants to merge 1 commit into huggingface:main from tanisha-samant:docs/fix-typo

tanisha-samant commented Sep 30, 2025

What I did:

Fixed a small typo in README to improve clarity
Fixed repeated word "frameworks frameworks"
Split long paragraphs into shorter sentences for readability
Added # Example comments before code blocks for clarity

Why:

Helps new users avoid confusion

How I tested:

Checked locally in Markdown preview


          Docs: fix typo, improve readability, add code comments

3ed916f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet