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.

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

docs: enhance README.md with TOC, examples and contributing guidelines #918

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: enhance README.md with TOC, examples and contributing guidelines #918

wants to merge 1 commit into from

Conversation

crStiv
Copy link

@crStiv crStiv commented Jan 10, 2025

This commit improves the README.md file by:

  • Adding a comprehensive Table of Contents for better navigation
  • Including usage examples with code snippets
  • Adding a detailed Contributing section with guidelines
  • Fixing minor grammar issues
  • Improving overall document structure and readability

@crStiv crStiv requested review from a team as code owners January 10, 2025 02:14
@crStiv crStiv requested review from z-tech, Pratyush and mmagician and removed request for a team January 10, 2025 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@z-tech z-tech Awaiting requested review from z-tech z-tech is a code owner automatically assigned from arkworks-rs/maintainers

@Pratyush Pratyush Awaiting requested review from Pratyush Pratyush is a code owner automatically assigned from arkworks-rs/maintainers

@mmagician mmagician Awaiting requested review from mmagician mmagician is a code owner automatically assigned from arkworks-rs/maintainers

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@crStiv