Skip to content

docs(readme): grammar, Harmony capitalization, MoE & LM Studio wording #98

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kunald08
Copy link

@kunald08 kunald08 commented Aug 8, 2025

Summary

Refines README wording and consistency. Documentation-only change; no code paths touched.

Changes

  • Capitalize “Harmony” when referring to the response format
  • Clarify LM Studio download sentence
  • Clarify MoE tensor storage (blocks/scales, FP4 capitalization)
  • Improve tool training phrasing (“were trained on”)
  • Clarify BF16 activations recommendation
  • Minor grammar/article and wording cleanups

Rationale

Improves readability and professionalism for new users and contributors.

Testing

  • Manual render review of README
  • No runtime or behavioral impact

Backward Compatibility

Safe: docs-only.

Checklist

  • Conventional commit message
  • Single-purpose change
  • No functional changes
  • CI expected to pass

Notes

Happy to adjust phrasing if maintainers prefer alternative wording.

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