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 Grammar Issues in Protocol SDK Documentation #440

Merged
merged 2 commits into from
Sep 17, 2024

Conversation

intls
Copy link
Contributor

@intls intls commented Aug 13, 2024

Closes #439

Description

This pull request corrects several grammar issues found in the introduction.mdx and index.mdx files within the Protocol SDK documentation. The changes improve clarity and readability by addressing incorrect word usage and sentence structure.

Motivation and Context

These changes were made to enhance the overall quality of the documentation, making it clearer and more professional for developers who rely on it. No functional or technical aspects of the documentation were altered.

Does this change the ABI/API?

  • This changes the ABI/API

What tests did you add/modify to account for these changes

No tests were added or modified, as these changes only affect the text in the documentation.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New module / feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I added a changeset to account for this change

Reviewer Checklist:

  • My review includes a symposis of the changes and potential issues
  • The code style is enforced
  • There are no risky / concerning changes / additions to the PR

@intls
Copy link
Contributor Author

intls commented Aug 13, 2024

Hi! My pull request is ready for review and merge. Thank you!

@iainnash
Copy link
Collaborator

ABIs is fine, but the interacting change is not necessarily cleaner imo.

@intls
Copy link
Contributor Author

intls commented Aug 14, 2024

ABIs is fine, but the interacting change is not necessarily cleaner imo.

Hi! I've reverted 'interaction' back to 'interacting' as requested. The pull request is updated and ready for further review. Thanks! @iainnash

@intls intls force-pushed the fix-grammar-issues branch 2 times, most recently from 97e2ad8 to d9c5433 Compare September 1, 2024 02:13
@oveddan oveddan merged commit c5b385d into ourzora:main Sep 17, 2024
1 check passed
iainnash pushed a commit that referenced this pull request Sep 26, 2024
* Corrected issues in protocol-deployments index.mdx and protocol-sdk introduction.mdx

* Reverted 'interaction' back to 'interacting' in introduction.mdx as per request
@intls intls deleted the fix-grammar-issues branch October 24, 2024 17:34
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.

Grammar Issues in Protocol SDK Docs
3 participants