Update indexer README #1482
Update indexer README #1482
Conversation
chenyaoy
force-pushed
the
chenyao/update-indexer-readme
branch
from
13f6264 to
6d09d99
Compare
|
Warning Rate Limit Exceeded@chenyaoy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 40 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe recent updates primarily focus on enhancing the documentation within the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (17)
indexer/README.md (17)
Line range hint
1-1: Add alt text to the image for accessibility.- <p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p> + <p align="center"><img src="https://dydx.exchange/icon.svg?" alt="dYdX Exchange Icon" width="256" /></p>
Line range hint
16-16: Consider using a more specific term than "ender" to describe the service.
49-49: Consider removing "of" for conciseness: "To build all services and packages, run:"
91-91: Consider removing "of" for conciseness: "First, make sure all services and packages are built with the latest code by running:"
Line range hint
194-194: Correct the verb form for clarity: "comlink will serve API requests from..."- `comlink` will serving API requests from `http://localhost:3002`. + `comlink` will serve API requests from `http://localhost:3002`.
Line range hint
202-202: Correct the verb form for clarity: "socks will accept websocket connections from..."- `socks` will accepting websocket connections from `http://localhost:3003`. + `socks` will accept websocket connections from `http://localhost:3003`.
Line range hint
27-27: Remove trailing spaces.-
Line range hint
135-135: Remove trailing spaces.-
Line range hint
213-213: Remove trailing spaces.-
Line range hint
29-29: Add a blank line above the heading for better readability.+ ### Installation
Line range hint
110-110: Add a blank line below the heading for better readability.## Adding Packages +
Line range hint
134-134: Add a blank line below the heading for better readability.## Adding Services +
Line range hint
139-139: Add a blank line above and below the heading for better readability.+ ## Running package.json scripts +
Line range hint
159-159: Add a blank line below the heading for better readability.## Protos +
Line range hint
177-177: Add a blank line below the heading for better readability.# Running Dockerfile locally +
Line range hint
193-193: Add a blank line below the heading for better readability.## Deploying +
Line range hint
201-201: Add a blank line below the heading for better readability.### Running local V4 node +
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- indexer/README.md (2 hunks)
Additional Context Used
LanguageTool (6)
indexer/README.md (6)
Near line 16: Try using a synonym here to elevate your writing.
Context: ...dYdX V4 application. The services that make up the V4 Indexer are: - ender: Receives o...
Near line 49: Consider removing “of” to be more concise
Context: ...`` pnpm install### Build To build all of the services and packages, run:pnpm r...
Near line 54: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s should be run whenever code is changed and you need to deploy or run the updated c...
Near line 91: Consider removing “of” to be more concise
Context: ...## Running unit tests First, make sure all of the services and packages are built with th...
Near line 194: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...I of locally run Indexercomlinkwill serving API requests from `http://localhost:300...
Near line 202: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...cket messages from Indexersockswill accepting websocket connections from `http://loca...
Path-based Instructions (1)
indexer/README.md (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.
chenyaoy
force-pushed
the
chenyao/update-indexer-readme
branch
from
6d09d99 to
31d418f
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (4)
indexer/README.md (4)
Line range hint
1-1: Add alt text to images for accessibility.- <p align="center"><img src="https://dydx.exchange/icon.svg?" width="256" /></p> + <p align="center"><img src="https://dydx.exchange/icon.svg?" alt="dYdX Exchange Icon" width="256" /></p>
Line range hint
7-7: Add alt text to images for accessibility.- <img src="https://github.com/dydxprotocol/v4-chain/actions/workflows/indexer-build-test-coverage.yml/badge.svg?branch=main" /> + <img src="https://github.com/dydxprotocol/v4-chain/actions/workflows/indexer-build-test-coverage.yml/badge.svg?branch=main" alt="Build Test Coverage Status" />
Line range hint
194-194: Correct verb form for modal verb "will".- `comlink` will serving API requests from `http://localhost:3002`. + `comlink` will be serving API requests from `http://localhost:3002`.
Line range hint
202-202: Correct verb form for modal verb "will".- `socks` will accepting websocket connections from `http://localhost:3003`. + `socks` will be accepting websocket connections from `http://localhost:3003`.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- indexer/README.md (2 hunks)
Additional Context Used
LanguageTool (6)
indexer/README.md (6)
Near line 16: Try using a synonym here to elevate your writing.
Context: ...dYdX V4 application. The services that make up the V4 Indexer are: - ender: Receives o...
Near line 49: Consider removing “of” to be more concise
Context: ...`` pnpm install### Build To build all of the services and packages, run:pnpm r...
Near line 54: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s should be run whenever code is changed and you need to deploy or run the updated c...
Near line 91: Consider removing “of” to be more concise
Context: ...## Running unit tests First, make sure all of the services and packages are built with th...
Near line 194: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...I of locally run Indexercomlinkwill serving API requests from `http://localhost:300...
Near line 202: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...cket messages from Indexersockswill accepting websocket connections from `http://loca...
Path-based Instructions (1)
indexer/README.md (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.
Additional comments not posted (2)
indexer/README.md (2)
48-48: Add a blank line below the heading for better readability.
54-54: Add a comma before "and" to connect two independent clauses.
chenyaoy
force-pushed
the
chenyao/update-indexer-readme
branch
from
31d418f to
5963e5b
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- indexer/README.md (2 hunks)
Additional Context Used
LanguageTool (6)
indexer/README.md (6)
Near line 16: Try using a synonym here to elevate your writing.
Context: ...dYdX V4 application. The services that make up the V4 Indexer are: - ender: Receives o...
Near line 49: Consider removing “of” to be more concise
Context: ...`` pnpm install### Build To build all of the services and packages, run:pnpm r...
Near line 54: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s should be run whenever code is changed and you need to deploy or run the updated c...
Near line 91: Consider removing “of” to be more concise
Context: ...## Running unit tests First, make sure all of the services and packages are built with th...
Near line 194: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...I of locally run Indexercomlinkwill serving API requests from `http://localhost:300...
Near line 202: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...cket messages from Indexersockswill accepting websocket connections from `http://loca...
Path-based Instructions (1)
indexer/README.md (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.
Additional comments not posted (4)
indexer/README.md (4)
48-48: Add a blank line below the "Build" heading for better readability.
49-49: Consider removing "of" to be more concise.
54-54: Add a comma before "and" to connect two independent clauses.
91-91: Consider removing "of" to be more concise.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Changelist
Update indexer README
Test Plan
[Describe how this PR was tested (if applicable)]
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.Summary by CodeRabbit