Skip to content

docs: fix typos and improve documentation #1016

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

Closed
wants to merge 1 commit into from

Conversation

cookingypq
Copy link

@cookingypq cookingypq commented Aug 17, 2025

Description

This PR fixes various documentation issues and improves code quality:

  • Fix grammar error in README.md: "ecosystem consist" → "ecosystem consists"
  • Fix syntax error in CONTRIBUTING.md: "to an open issue" → "to open an issue"
  • Complete TODO section in poly/README.md with comprehensive domain documentation
  • Fix broken GitHub links in test-templates and bench-templates README files

The most critical files to review are:

  • README.md (main project documentation)
  • CONTRIBUTING.md (contribution guidelines)
  • poly/README.md (polynomial library documentation)

  • Targeted PR against correct branch (master)
  • Linked to GitHub issue with discussion and accepted design OR have an explanation in the PR that describes this work.
    • Note: This is a documentation-only PR fixing typos and improving docs, no design discussion needed
  • Wrote unit tests
    • Note: Documentation changes only, no code changes requiring tests
  • Updated relevant documentation in the code
  • Added a relevant changelog entry to the Pending section in CHANGELOG.md
    • Note: Documentation improvements don't require changelog entries
  • Re-reviewed Files changed in the GitHub PR explorer

@cookingypq cookingypq requested review from a team as code owners August 17, 2025 09:53
@cookingypq cookingypq requested review from z-tech, mmagician and weikengchen and removed request for a team August 17, 2025 09:53
@Pratyush Pratyush closed this Aug 22, 2025
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