feat(docs): Added packages docs to Hubble #356
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@SVell is attempting to deploy a commit to the farcaster Team on Vercel. A member of the Team first needs to authorize it. |
This was referenced Dec 11, 2024
sds
pushed a commit
to farcasterxyz/hub-monorepo
that referenced
this pull request
Dec 12, 2024
## Why is this change needed? Since changes were requested in docs (farcasterxyz/docs#54), I have made a PR to update Farcaster's docs (farcasterxyz/docs#356), thus decided to update the readme file. ## Merge Checklist _Choose all relevant options below by adding an `x` now or at any time before submitting for review_ - [ ] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [ ] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [x] PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore) - [ ] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. <!-- start pr-codex --> --- ## PR-Codex overview This PR adds a new function for retrieving a user's first name using their FID from the `HubRpcClient`. ### Detailed summary - Introduced a new function `getFnameFromFid`. - The function takes `fid` (number) and `client` (`HubRpcClient`) as parameters. - It retrieves user data of type `UserDataType.FNAME`. - Returns the user's first name or an empty string if not found. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added packages docs for @farcaster/hub-web and @farcaster/hub-nodejs
Refs: #54
PR-Codex overview
This PR adds new documentation for the
@farcaster/hub-nodejsand@farcaster/hub-webpackages, detailing their features, installation instructions, usage examples, and contributing guidelines. It also updates the navigation structure in the documentation.Detailed summary
Packagesindocs/.vitepress/config.mts.@farcaster/hub-nodejs, including:@farcaster/hub-web, including: