fix: typos #1893
fix: typos #1893
Conversation
WalkthroughThis pull request updates the documentation in the light node guide by fixing a spelling error in the section header and expanding the instructions. The revised content now includes details on passing the directory containing the JSON x-token to the light node, outlines the correct command usage, and specifies the necessary file permissions along with the JSON structure required for the x-token. Changes
Possibly related PRs
Suggested reviewers
Poem
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 0
🧹 Nitpick comments (1)
how-to-guides/light-node.md (1)
182-201: Enhance security guidance for authentication setup.While the instructions are technically accurate, consider strengthening the security guidance:
- Add a warning about keeping the x-token secure and not sharing it
- Recommend storing the token file outside of version control
- Clarify that the example domain and token are placeholders
Apply this diff to enhance the security guidance:
If you are running a light node with a core endpoint that requires authentication, you can pass the directory containing the json of your x-token to the light node with the following command: + +:::warning +Keep your x-token secure and never share it or commit it to version control. +::: ```sh celestia light start \ - --core.ip snowy-methodical-leaf.celestia-mainnet.quiknode.pro \ + --core.ip <YOUR-ENDPOINT> \ --core.tls \ --core.xtoken.path /path-to-directory \ --core.port 9090Where
/path-to-directoryis the path to the directory containing the
-x-token.jsonfile. Ensure the file has restricted permissions (e.g.,chmod 600) and contains:
+x-token.jsonfile. Store this file outside of version control and ensure it has
+restricted permissions (e.g.,chmod 600). The file should contain:{ - "x-token": "<YOUR-SECRET-X-TOKEN>" + "x-token": "<YOUR-SECRET-X-TOKEN>" // Replace with your actual token }</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between f2fa90cd99fae281076e071d7f736aa1ae019063 and 574e1e1d04153099816e8f9abca91b7ef7997af8. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `how-to-guides/light-node.md` (1 hunks) </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>how-to-guides/light-node.md (1)</summary> `180-180`: **LGTM! Spelling correction improves documentation quality.** </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
|
@jcstein Hi! Just wanted to remind you about this PR. If you have some time, please take a look. Thank you! |
This pull request contains changes to improve clarity, correctness and structure.
Summary by CodeRabbit