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

Technical Accuracy #2456

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

Technical Accuracy #2456

wants to merge 2 commits into from

Conversation

HubertIGL
Copy link

@HubertIGL HubertIGL commented Dec 24, 2024

1. apps/hubble/www/docs/docs/httpapi/links.md

- | target_fid | The FID of the reaction's creator | `fid=6833` |
+ | target_fid | The FID of the link's target | `target_fid=6833` |

Reason: Fixed incorrect parameter description and example to accurately reflect the target_fid parameter's purpose in the Links API.

2. apps/hubble/www/docs/docs/httpapi/message.md

- message valid. Or to validate message that cannot be submitted (e.g. Frame actions)
+ message valid. Or to validate messages that cannot be submitted (e.g. Frame actions)

Reason: Corrected grammar by making "message" plural for better readability and grammatical accuracy.

3. apps/hubble/www/docs/docs/api.md

- // Calculate the blake3 hash, trucated to 20 bytes
+ // Calculate the blake3 hash, truncated to 20 bytes

Reason: Fixed typo in technical documentation ("trucated" → "truncated") for accuracy in code comments.


PR-Codex overview

This PR focuses on improving documentation clarity and correcting minor typographical errors in the API documentation for links.md and message.md.

Detailed summary

  • In links.md, changed the example for target_fid from fid=6833 to target_fid=6833.
  • In message.md, corrected the spelling of "trucated" to "truncated" in a comment.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Dec 24, 2024

⚠️ No Changeset found

Latest commit: 48c7615

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Dec 24, 2024

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

Name Status Preview Comments Updated (UTC)
hub-monorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 24, 2024 4:48pm

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