Polish Documentation and Improve Readability

[ananos]

The current documentation across the repository could use some cleanup for clarity and structure. This includes improving the main README and module-specific files.

Details

We should:

• Fix grammar, typos, and formatting issues across all .md files.
• Ensure a consistent heading hierarchy.
• Clarify ambiguous or overly brief descriptions.
• Ensure code blocks are properly fenced and styled.

This will help new contributors and users better understand how to use and contribute to MLSysOps.

[RR-Sahoo]

@ananos Hi! 👋
I would like to address this issue. I have 2 years of frontend experience and some open-source contributions as well.
I’ll go through all .md files to improve grammar, structure, and formatting as outlined.

Could you please assign this to me? 🙌

[ananos]

Hi @RR-Sahoo!

thanks so much for your interest in our project. Consider this issue assigned it to you, but you'll need to open a draft PR with at least something in order for us to assign it to you.

Also, you'll have to give us some time to fix the CI to allow external PRs.

Looking forward to your contributions!

[RR-Sahoo]

Hi @ananos! 👋 I’ve opened a draft PR as requested: #41
Let me know if any changes are needed. Looking forward to contributing more! 😊

[ananos]

Hi @RR-Sahoo!

thanks for opening up a PR!

As @ReedMerrill has already been working on the contibuting.md document I would suggest working on another part of the docs (to avoid conflicts).

As a general rule of thumb, please take into account that using AI tools to facilitate text polishing is fine, as long as it is used for polishing.

Also, please have a look at the contributing guide, we use conventional commits, so please refine your commit message as well.

thanks! looking forward to your contributions!

[RR-Sahoo]

Hi @ananos! Thanks for the update. 😊

Sure, I’ll stop work on CONTRIBUTING.md to avoid any conflicts and will pick another section of the docs to work on next.

Also, noted on the commit message style — I’ll make sure to follow the conventional commits format going forward.

Appreciate the guidance, and looking forward to contributing more!