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

Fix typos, improve clarity, and update formatting across documentation #474

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

gap-editor
Copy link

Description:

  • 📝 Fixed grammatical errors and typos across multiple files
  • 🔍 Improved clarity in explanations and instructions
  • 🖋 Reformatted code blocks for consistency
  • 🔗 Updated broken links and references
  • ✅ Ensured proper Markdown rendering for better readability

I replaced ([a-f0-9]+?) with ([^/]+). This change captures any sequence of characters (except for the forward slash /) after /blob/. This allows the regular expression to match not only commit hashes but also branch names or tags, which may include characters beyond just hexadecimal digits. This makes the script more flexible and compatible with various GitHub URL formats.
I removed the duplicate "the" and changed "static contents hosting service" to "static content hosting service" to correctly refer to the type of hosting.
I removed the optional chaining when retrieving the control block and replaced it with an explicit check to ensure that scriptTaproot.witness exists and contains elements. This change helps prevent using an undefined witness value by throwing an error if it’s missing, thereby improving the code's robustness.
typo fix, missing article, unnecessary comma
Added detailed proposal for Optimistic Merged Mining in BOB roadmap, including motivation, specification, security considerations, and optional reference implementation.
 Improvements ensure clarity, precision, and consistency.
Typo and clarity fixes
typo and clarity fixes
more structured and readable, fixed clarity
Fixed some issuies, improved code block formatting for readability, enhanced bullet points for clarity.
Copy link

changeset-bot bot commented Feb 2, 2025

⚠️ No Changeset found

Latest commit: 4ee9ccf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Feb 2, 2025

@gap-editor is attempting to deploy a commit to the distributed-crafts Team on Vercel.

A member of the Team first needs to authorize it.

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