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.

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

docs: enhance README structure and contributor guidance #937

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

crStiv
Copy link
Contributor

@crStiv crStiv commented Jan 15, 2025

Improve README.mdx documentation with the following changes:

  • Add Quick Links section for better navigation
  • Restructure contribution guidelines with clear steps
  • Add "Before You Start" section for new contributors
  • Improve visual hierarchy with better formatting
  • Add explicit steps for making and submitting changes

These changes aim to make the contribution process more accessible
and provide clearer guidance for new contributors.

Copy link

vercel bot commented Jan 15, 2025

@crStiv is attempting to deploy a commit to the Consensys Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Collaborator

@jlwllmr jlwllmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, LGTM!

Copy link

vercel bot commented Jan 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
doc-zk-evm ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 9:47am

@jlwllmr jlwllmr merged commit 6139e73 into Consensys:main Jan 17, 2025
6 checks passed
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