Skip to content

Commit

Permalink
fix typos in documentation files (#2398)
Browse files Browse the repository at this point in the history
## Why is this change needed?

This change is necessary to enhance documentation consistency, improve
accuracy in code comments, and provide users with a clear understanding
of the project’s structure and usage guidelines. Updating these files
ensures that developers and contributors can navigate and utilize the
codebase more effectively, reducing potential errors and
miscommunications. These improvements directly support maintaining
high-quality standards and accessibility in the Hubble ecosystem,
benefiting both new and experienced users.

## Merge Checklist

- [x] PR title adheres to the [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/) standard
- [x] 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)
- [x] 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 focuses on fixing typos and improving documentation across
various files in the project, enhancing clarity and consistency in
language.

### Detailed summary
- Fixed typo in `CHANGELOG.md` regarding "unexpectedly".
- Updated "Go lang" to "Golang" in `CHANGELOG.md`.
- Corrected phrasing in `feature.md`.
- Standardized "Nodejs" to "Node.js" in multiple files.
- Clarified "Fids" to "FIDs" in `Messages.md`.
- Improved description in `README.md` for consistency.

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

<!-- end pr-codex -->
  • Loading branch information
futreall authored Nov 20, 2024
1 parent df0b629 commit b69cb8f
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A concise, high level summary of the feature
**Why is this feature important?**
An argument for why this feature should be built and how it should be prioritized

**Will the protocol spec need to be updated??**
**Will the protocol spec need to be updated?**
Call out the sections of the [protocol spec](https://github.com/farcasterxyz/protocol) that will need to be updated (e.g. Section 4.3 - Verifications, Section 3.1 - Identity Systems)

**How should this feature be built? (optional)**
Expand Down
2 changes: 1 addition & 1 deletion apps/hubble/src/addon/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Rust Addons for Hubble
This directory contains the addon code for Hubble. It uses neon to call from NodeJS into Rust. The rust library is compiled into the binary file `index.node` (see `Cargo.toml` and `package.json`) and copied into the `addon` folder. This can then be imported into a TS file like a normal JS import (see `rustfunctions.ts`)o
This directory contains the addon code for Hubble. It uses neon to call from NodeJS into Rust. The rust library is compiled into the binary file `index.node` (see `Cargo.toml` and `package.json`) and copied into the `addon` folder. This can then be imported into a TS file like a normal JS import (see `rustfunctions.ts`)

### Setting up vscode
If you open the root folder or `apps/hubble` folder in vscode, vscode will treat the entire project as a typescript project and not activate the rust plugins (like `rust-analyzer`). To make vscode load the rust plugins, you need to File -> Add folder to workspace -> navigate to apps/hubble/src/addon. This will add the `addon` folder to the workspace and let you use the Typescript and Rust vscode plugins side-by-side.
Expand Down
4 changes: 2 additions & 2 deletions apps/hubble/www/docs/docs/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ A Message is a delta operation on the Farcaster network. The message protobuf is
| signature | bytes | | Signature of the hash digest |
| signature_scheme | [SignatureScheme](#SignatureScheme) | | Signature scheme that produced the signature |
| signer | bytes | | Public key or address of the key pair that produced the signature |
| data_bytes | bytes | | Alternate to the "data" field. If you are constructing the [MessageData](#MessageData) in a programing language other than Typescript, you can use this field to serialize the `MessageData` and calculate the `hash` and `signature` on these bytes. Optional. |
| data_bytes | bytes | | Alternate to the "data" field. If you are constructing the [MessageData](#MessageData) in a programming language other than Typescript, you can use this field to serialize the `MessageData` and calculate the `hash` and `signature` on these bytes. Optional. |

### 1.1 MessageData

A MessageData object contains properties common to all MessagesTypes and wraps a body object which contains properties specific to the MessageType.
A MessageData object contains properties common to all MessageTypes and wraps a body object which contains properties specific to the MessageType.

| Field | Type | Label | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ---------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions apps/hubble/www/docs/intro/hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Farcaster team runs some instances of Hubble for use by the public. These in

```bash
url: nemes.farcaster.xyz
httpapi_port: 2281
http_api_port: 2281
gossipsub_port: 2282
grpc_port: 2283
```
Expand All @@ -23,4 +23,4 @@ grpc_port: 2283

Hubble instances can also be hosted for you by other service providers. While we recommend running your own instance for sovereignty and security, it may be useful to use these services to prototype quickly.

- [Hubs x Neynar](https://hubs.neynar.com/)
- [Hubs x Neynar](https://hubs.neynar.com/)
4 changes: 2 additions & 2 deletions packages/hub-nodejs/docs/Messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Due to a quirk of how gRPC compiles types to TypeScript, MessageData has many op
| Name | Type | Description |
| :------------------- | :------------------ | ------------------------------------- |
| `embeds?` | `string[]` | URLs to be embedded in the cast |
| `mentions?` | `number[]` | Fids mentioned in the cast |
| `mentions?` | `number[]` | FIDs mentioned in the cast |
| `mentionsPositions?` | `number[]` | Positions of the mentions in the text |
| `parentCastId?` | [`CastId`](#castid) | Parent cast of the cast |
| `text` | `string` | Text of the cast |
Expand Down Expand Up @@ -190,7 +190,7 @@ Unique identifier for a Cast that includes its author.

| Name | Type | Description |
| :----- | :------- | ------------------------------------ |
| `fid` | `number` | Fid of the user who created the cast |
| `fid` | `number` | FID of the user who created the cast |
| `hash` | `string` | Hash of the cast |

### VerificationEthAddressClaim
Expand Down
2 changes: 1 addition & 1 deletion packages/hub-nodejs/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Note: The HTTP API is an alternate way to read/write to the Hub. Please see the
1. Timestamps are calculated from the [Farcaster epoch](./Utils.md#time), not the Unix epoch.
2. Errors are handled with [a monadic pattern](./Utils.md#errors), instead of try-catch.
3. [Ethers](https://www.npmjs.com/package/ethers) and [noble](https://www.npmjs.com/package/@noble/ed25519) are required to create new messages.
4. Both Nodejs and [browser environments are supported](https://github.com/farcasterxyz/hubble/issues/573).
4. Both Node.js and [browser environments are supported](https://github.com/farcasterxyz/hubble/issues/573).
5. Fixed length data is encoded in [byte formats](./Utils.md#bytes), instead of strings.

There are also a few Farcaster-specific terms that are very commonly used in this package:
Expand Down
2 changes: 1 addition & 1 deletion packages/hub-web/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@

### Patch Changes

- 06bb2f43: chore: Go lang example for submitMessage()
- 06bb2f43: chore: Golang example for submitMessage()
- a5708f85: chore: Remove grpc-web
- ba86d374: feat: Allow signing raw message data bytes to support rust, Golang etc...
- Updated dependencies [ba86d374]
Expand Down
4 changes: 2 additions & 2 deletions packages/hub-web/README.grpcweb.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ import { getHubRpcClient } from '@farcaster/hub-web';
(async () => {
const client = getHubRpcClient('https://testnet1.farcaster.xyz:2285');

// If you're using gRPC-Web from a Nodejs environment, add a second false parameter
// If you're using gRPC-Web from a Node.js environment, add a second false parameter
// const nodeClient = getHubRpcClient('https://testnet1.farcaster.xyz:2285', false);
})();
```
Expand All @@ -69,7 +69,7 @@ import { getHubRpcClient } from '@farcaster/hub-web';
| Name | Type | Description |
| :---------- | :-------- | :------------------------------------------------------------------------- |
| `url` | `string` | Address and RPC port string (e.g. `https://testnet1.farcaster.xyz:2285`) |
| `isBrowser` | `boolean` | Optional parameter indicating whether to use the gRPC-Web Nodejs transport |
| `isBrowser` | `boolean` | Optional parameter indicating whether to use the gRPC-Web Node.js transport |

### Streaming hub events

Expand Down
2 changes: 1 addition & 1 deletion packages/shuttle/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

### Patch Changes

- 386059ac: fix: gracefully handle streaming hangups when the server dies unexpected
- 386059ac: fix: gracefully handle streaming hangups when the server dies unexpectedly

## 0.6.5

Expand Down
2 changes: 1 addition & 1 deletion protobufs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Specifications for API's and data formats used in Hubble, including both Farcast
| [HubEvent](schemas/hub_event.proto) | Types for hub events | [docs](docs/message.md) |
| [RPC](schemas/rpc.proto) | Types for gRPC APIs exposed by Hubs | [docs](docs/rpc.md) |
| [Gossip](schemas/gossip.proto) | Types for gossiping data between Hubs | |
| [HubState](schemas/hub_state.proto) | Types for for maintaining internal state | |
| [HubState](schemas/hub_state.proto) | Types for maintaining internal state | |

## Getting Started

Expand Down

0 comments on commit b69cb8f

Please sign in to comment.