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

Pull Request Title: fix(docs): improve clarity, grammar, and consistency across workshop and hackathon docs #462

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

Conversation

NikolaiKryshnev
Copy link

Pull Request Description:

Summary

This PR addresses grammatical errors, improves phrasing, and ensures consistency across multiple documentation files. Changes have been made in the following areas:

  1. General grammar and spelling fixes: Corrected minor typos, improved clarity, and ensured consistent terminology throughout the documentation.
  2. Consistency improvements: Standardized phrasing and terminology like "GitHub repository" and "set up" vs. "setup" across docs.
  3. Formatting fixes: Adjusted capitalization, punctuation, and spacing for better readability.

Key Changes

  • NOMENCLATURE.md: Improved sentence structure and fixed inconsistent word usage (e.g., "running" instead of "run").
  • INSPIRATION.md: Corrected typos (e.g., "we’d" → "we would"), adjusted capitalization, and improved clarity.
  • README.md: Fixed phrasing around the Aztec Sandbox setup process and corrected spelling errors.
  • TOOLS.md: Corrected terminology (e.g., "highlight" → "highlighting"), ensured uniform library descriptions, and fixed grammar.
  • workshops/devconnect-2023/build-account-contract/README.md: Improved link descriptions and capitalization for consistency.

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.

1 participant