Add code guidelines description #408
Conversation
Deploying coderabbit-docs with
|
| Latest commit: |
cfdef2c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9b7afd41.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://code-guidelines.coderabbit-docs.pages.dev |
ganeshpatro321
force-pushed
the
code-guidelines
branch
from
c671be0 to
d9e2278
Compare
ganeshpatro321
force-pushed
the
code-guidelines
branch
from
d9e2278 to
cfdef2c
Compare
WalkthroughA new "Code Guidelines" section has been added to the documentation, detailing how CodeRabbit can analyze and learn from organizational code guidelines configured in the knowledge base. The section specifies default file patterns for guideline detection and includes an illustrative image. Changes
Poem
✨ Finishing Touches🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (4)
docs/integrations/knowledge-base.md (4)
28-28: Correct verb usage and maintain consistent spelling.
Replace the verb “setup” with “set up” and harmonize spelling (e.g., US English “analyze” and “organization’s”).- CodeRabbit will analyse and learn from your organisation's code guidelines, which you can setup in the knowledge base section. + CodeRabbit will analyze and learn from your organization's code guidelines, which you can set up in the knowledge base section.
30-30: Fix grammar in the patterns introduction.
Change “These set of patterns are scanned by default.” to a clearer phrasing such as “The following patterns are scanned by default.”- These set of patterns are scanned by default. + The following patterns are scanned by default.
32-40: Specify code fence language for syntax highlighting.
Add a language identifier (e.g.,textoryaml) after the opening triple backticks to improve readability.- ``` + ```text
42-42: Enhance image alt text for accessibility.
Use more descriptive alt text to convey the image’s purpose.-  + 
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
static/img/knowledge-base/code-guidelines.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
docs/integrations/knowledge-base.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/integrations/knowledge-base.md
[grammar] ~28-~28: The word “setup” is a noun. The verb is spelled with a space.
Context: ...sation's code guidelines, which you can setup in the knowledge base section. These gu...
(NOUN_VERB_CONFUSION)
🪛 markdownlint-cli2 (0.17.2)
docs/integrations/knowledge-base.md
32-32: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
No description provided.