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

Correct Documentation Issues and Ensure Proper API Field Naming #624

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

savvar9991
Copy link

1.In CONTRIBUTING.md:

-We welcome contributations for bug fixes and performance improvements.
+We welcome contributions for bug fixes and performance improvements.

Fixes grammatical error in the word "contributations" (this word doesn't exist)

2.In ops/webhooks/README.md:

-Run ./install-_dependencies.sh
+Run ./install_dependencies.sh

Fixes incorrect file naming containing redundant -_ characters
Prevents potential command execution errors

3. In packages/api/README.md:

-"estimatedRecieved": "747908",
+"estimatedReceived": "747908",

Prevents potential issues with API response parsing by clients expecting correct field naming
Improves API documentation quality

Copy link

netlify bot commented Jan 7, 2025

Deploy Preview for hop-sdk-docs canceled.

Name Link
🔨 Latest commit f01ca06
🔍 Latest deploy log https://app.netlify.com/sites/hop-sdk-docs/deploys/677cf273aaa1670008d1e5a8

@savvar9991
Copy link
Author

@miguelmota Sorry for pinging, but could you please take a look at this PR when you have a moment?

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