-
Notifications
You must be signed in to change notification settings - Fork 52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor fixes #401
Minor fixes #401
Conversation
WalkthroughThe recent changes enhance the installation and initialization processes in various scripts and tutorials. An Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Outside diff range and nitpick comments (5)
tutorials/celestia-da.md (2)
Line range hint
72-72
: Specify a language for the fenced code block.For better readability and syntax highlighting, specify the language for the code block.
- ```bash + ```bash
Line range hint
113-114
: Address the exposure of the JSON Web Token (JWT).Exposing JWTs in documentation can lead to security vulnerabilities. Consider removing or obfuscating the token.
- Your DA AUTH_TOKEN is eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBbGxvdyI6WyJwdWJsaWMiLCJyZWFkIiwid3JpdGUiXX0.cSrJjpfUdTNFtzGho69V0D_8kyECn9Mzv8ghJSpKRDE + Your DA AUTH_TOKEN is <REDACTED>tutorials/gm-world.md (3)
Line range hint
69-69
: Add missing blank lines around fenced code blocks.For better readability and to comply with Markdown standards, ensure that fenced code blocks are surrounded by blank lines.
+ <Extra blank line>
Line range hint
69-69
: Specify a language for the fenced code block.For better readability and syntax highlighting, specify the language for the code block.
- ```bash-vue + ```bash
Line range hint
154-155
: Address the potential exposure of generic API keys.Exposing API keys in documentation can lead to security vulnerabilities. Consider removing or obfuscating the keys.
- export KEY1=gm18k57hn42ujcccyn0n5v7r6ydpacycn2wkt7uh9 - export KEY2=gm1e4fqspwdsy0dzkmzsdhkadfcrd0udngw0f88pw + export KEY1=<REDACTED> + export KEY2=<REDACTED>Also applies to: 155-156
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- public/install.sh (1 hunks)
- tutorials/celestia-da.md (1 hunks)
- tutorials/gm-world.md (1 hunks)
Files skipped from review due to trivial changes (1)
- public/install.sh
Additional context used
Markdownlint
tutorials/celestia-da.md
60-60: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
63-63: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
72-72: null (MD040, fenced-code-language)
Fenced code blocks should have a language specifiedtutorials/gm-world.md
69-69: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
69-69: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Gitleaks
tutorials/celestia-da.md
113-114: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data. (jwt)
tutorials/gm-world.md
154-155: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
155-156: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
LanguageTool
tutorials/gm-world.md
[uncategorized] ~151-~151: A comma is probably missing here. (MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...
[uncategorized] ~158-~158: You might be missing the article “a” here. (AI_EN_LECTOR_MISSING_DETERMINER_A)
Context: ... flags, for now, we just want to submit transaction from a high-level perspective): ```bas...
Additional comments not posted (2)
tutorials/celestia-da.md (1)
Line range hint
60-60
: Remove extra blank lines to adhere to Markdown best practices.There are multiple consecutive blank lines which can be cleaned up for better readability and to comply with Markdown linting rules.
[REFACTOR_SUGGESTion]- <Extra blank line>
Also applies to: 63-63
tutorials/gm-world.md (1)
65-65
: Ensure correct directory context before running initialization commands.The updated command ensures that the
rollkit toml init
is executed in the correct directory, which is crucial for correct application setup. This is a good practice to avoid path-related errors.
Summary by CodeRabbit
Chores
install.sh
script to fetch the latest changes before switching branches.Documentation
tutorials/celestia-da.md
.rollkit toml init
command in thegm-world.md
tutorial.