-
Notifications
You must be signed in to change notification settings - Fork 102
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
Update README.md #98
Update README.md #98
Conversation
WalkthroughThe recent change involved fixing a typo in the documentation related to the n8n configuration options. This update ensures that the documentation is accurate and clear, improving the overall usability and understanding of the configuration settings. 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 (7)
README.md (7)
Line range hint
137-137
: Consider changing "like shown above" to "as shown above" for grammatical correctness.- like shown above + as shown above
Line range hint
320-320
: Consider adding "the" before "same n8n installation" to improve readability.- instances of same n8n installation. + instances of the same n8n installation.
Line range hint
322-322
: Remove the comma before "because" as it is essential to the meaning of the sentence.- availability, because the controller instance remains as Single-Point-Of-Failure. + availability because the controller instance remains as Single-Point-Of-Failure.
Line range hint
354-354
: Correct the word order for clarity.- At last scaling option is it possible to create dedicated webhook instances, + At last, it is possible to create dedicated webhook instances in the scaling option,
Line range hint
134-134
: Consider adjusting the heading level for consistency.- ### Values + ## Values
Line range hint
320-320
: Remove trailing spaces to adhere to Markdown best practices.- instances of same n8n installation. + instances of same n8n installation.
Line range hint
4-4
: Consider reducing multiple consecutive blank lines to a single blank line to adhere to Markdown best practices.- - +Also applies to: 5-5, 15-15, 16-16, 17-17, 367-367
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[style] ~31-~31: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart. (IN_MANY_STYLE_CASES)
Context: ...defaults, not the application defaults. In many cases, the Helm Chart defaults are empty. The...
[grammar] ~137-~137: Did you mean “as”? (LIKE_SHOWN_TO_AS_SHOWN)
Context: ...secret
where you paste the n8n config like shown above. ```yaml # The n8n related...
[uncategorized] ~320-~320: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...is shared between multiple instances of same n8n installation. This provides a sh...
[formatting] ~322-~322: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause. (COMMA_BEFORE_BECAUSE)
Context: ...nstances and a limited high availability, because the controller instance remains as Sing...
[uncategorized] ~354-~354: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...efault, no redis server is spawned. At last scaling option is it possible to create...
[uncategorized] ~354-~354: Unless this sentence is a question, use ‘it is’ instead of ‘is it’. (IS_IT_WORD_ORDER)
Context: ...ver is spawned. At last scaling option is it possible to create dedicated webhook in...
Markdownlint
README.md
134-134: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
320-320: Expected: 0 or 2; Actual: 3 (MD009, no-trailing-spaces)
Trailing spaces
4-4: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
5-5: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
15-15: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
16-16: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
17-17: Expected: 1; Actual: 4 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
367-367: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
Summary by CodeRabbit