docs: node.store usage updates for celestia-node
Overview
Resolves #1531
This PR should be merged after https://github.com/celestiaorg/docs/pull/1532 is live on a celestia-node release, Mainnet Beta, Mocha, and Arabica.
Walkthrough
The changes streamline the handling of --node.store flags in the Celestia API commands. In version v0.14.0+, the flag has been removed from various commands due to the automation of node detection. This reduces redundancy and simplifies user interaction with the Celestia node. Documentation updates also clarify the need for setting node store paths only for specific custom scenarios.
Changes
| Files | Change Summary |
|---|---|
developers/celestia-node-key.md |
Default directory paths for saving node data and configurations based on node type and chain ID, clarified default network setting. |
developers/node-tutorial.md |
Updated commands to remove --node.store flag, clarified scenarios requiring node store path settings. |
nodes/celestia-node-troubleshooting.md |
Enhanced node detection logic, automated node detection, clarified configuration details and authentication behavior. |
Sequence Diagram(s)
The changes are too varied and simple to warrant generating a sequence diagram.
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
celestia-node's --node.store flag is no longer necessary on RPC requests using default node stores (Issue #1531) |
✅ | |
| node.store not a valid flag in cel-key (Issue #1602) | ❓ | The PR does not address the invalid --node.store flag in the cel-key utility mentioned in the issue. |
| Update node-tutorial with new values from celestia-node v0.14.x (Issue #1450) | ✅ |
Possibly related issues
- celestiaorg/docs#1602: The PR does not address the invalid
--node.storeflag in thecel-keyutility mentioned in the issue.
Poem
In the nodes where data plays,
--node.storeflag no longer stays. Commands are light, paths made bright, Automated logic takes flight. Celestia hums in v0.14, A seamless dance, an efficient scene.
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?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
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)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
PR Preview Action v1.4.7
:---:
:rocket: Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1532/
on branch main at 2024-06-26 14:11 UTC
Apologies for delay. LGTM otherwise 🎉
this is ready for review ahead of it being live on Mocha next week