Add a new reference section for code guidelines.

[jmacdotorg]

• Adds a new section to the configuration page about code guidelines.
• Rewrites the code guidelines section on the knowledge base base, explaining what the feature does and how it works by default, and directing the reader to the new configuration section for more detailed information.

Staged:

• https://code-guidelines.coderabbit-docs.pages.dev/integrations/knowledge-base#code-guidelines
• https://code-guidelines.coderabbit-docs.pages.dev/reference/configuration#code-guidelines

Summary by CodeRabbit

• Documentation
  • Updated and clarified the description of how code guideline files are used in code reviews.
  • Revised instructions for specifying custom code guideline files and noted the feature is enabled by default.
  • Added detailed configuration options for managing code guideline files, including enabling/disabling the feature and specifying file patterns.
  • Provided both Web UI and YAML configuration examples for easier setup.

[coderabbitai]

Caution

Review failed

Failed to post review comments.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1d1d0f5 and ce65ce2.

📒 Files selected for processing (2)

• docs/integrations/knowledge-base.md (1 hunks)
• docs/reference/configuration.md (1 hunks)

🧰 Additional context used

🧠 Learnings (7)

📓 Common learnings

Learnt from: jmacdotorg
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-07-30T16:14:47.514Z
Learning: In the coderabbitai/coderabbit-docs repository, spelling and grammar errors in documentation should be treated as bugs that require correction prior to merge, not as minor typos or nitpick suggestions. Documentation has higher quality standards than typical code reviews.

Learnt from: jmacdotorg
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-07-30T16:12:18.156Z
Learning: In the coderabbitai/coderabbit-docs repository, spelling and grammar errors in documentation should be treated as bugs that require correction prior to merge, not as minor or optional suggestions. Documentation quality standards are high and such errors are blocking issues.

Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.

Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.

Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the `docs` repository, it's acceptable to use `127.0.0.1` in documentation examples, and CodeRabbit should not flag it as an issue.

Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.

📚 Learning: in the coderabbitai/coderabbit-docs repository, spelling and grammar errors in documentation should ...

Learnt from: jmacdotorg
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-07-30T16:14:47.514Z
Learning: In the coderabbitai/coderabbit-docs repository, spelling and grammar errors in documentation should be treated as bugs that require correction prior to merge, not as minor typos or nitpick suggestions. Documentation has higher quality standards than typical code reviews.

Applied to files:

• docs/integrations/knowledge-base.md
• docs/reference/configuration.md

📚 Learning: in the coderabbitai/coderabbit-docs repository, spelling and grammar errors in documentation should ...

Learnt from: jmacdotorg
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-07-30T16:12:18.156Z
Learning: In the coderabbitai/coderabbit-docs repository, spelling and grammar errors in documentation should be treated as bugs that require correction prior to merge, not as minor or optional suggestions. Documentation quality standards are high and such errors are blocking issues.

Applied to files:

• docs/integrations/knowledge-base.md
• docs/reference/configuration.md

📚 Learning: the word "coderabbit" should always have both c and r capitalized (not "coderabbit", "coderabbit", o...

Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.

Applied to files:

• docs/integrations/knowledge-base.md

📚 Learning: for files in docs/tools/*.md directory: do not recommend installation instructions or usage setup st...

Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.

Applied to files:

• docs/integrations/knowledge-base.md
• docs/reference/configuration.md

📚 Learning: in documentation files, ensure all markdown image tags follow seo guidelines and maintain consistenc...

Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#115
File: docs/about/features.md:72-72
Timestamp: 2024-10-24T10:08:27.858Z
Learning: In documentation files, ensure all markdown image tags follow SEO guidelines and maintain consistency across Docs Pull Requests.

Applied to files:

• docs/integrations/knowledge-base.md

📚 Learning: in the coderabbit documentation, image paths in markdown files should reference the `/img/` director...

Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.

Applied to files:

• docs/integrations/knowledge-base.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (1)

docs/integrations/knowledge-base.md (1)

22-34: Ensure anchor slug matches configuration page

The link points to /reference/configuration#code-guidelines, which relies on Docusaurus’ auto-generated slug.
In docs/reference/configuration.md the heading is “### Code guidelines” (no explicit {#code-guidelines} anchor), so the slug will match, but any future heading change could silently break this link.

Recommend hard-coding the anchor in the reference file:

### Code guidelines {#code-guidelines}

to make the cross-reference robust.

📝 Walkthrough

Walkthrough

The documentation for CodeRabbit's knowledge base was clarified to better explain how code guideline files are used in reviews. The configuration reference added a new section allowing users to enable or disable code guideline enforcement and specify file patterns for guideline documents.

Changes

Cohort / File(s)	Change Summary
Knowledge Base Documentation docs/integrations/knowledge-base.md	Clarified and expanded the "Code Guidelines" section, updated heading anchors, removed example file patterns and images, and added references to configuration settings.
Configuration Reference Update docs/reference/configuration.md	Introduced a new "Code guidelines" section under "Knowledge Base" settings describing enablement, file pattern customization, and default guideline file paths.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

In the docs, a fresh breeze blows,
Guideline wisdom now clearly shows.
Patterns and toggles, all in a row,
For teams to shape how their code should flow.
With every review, the standards grow—
CodeRabbit’s guidance, ready to go! 🐇✨

Pre-Merge Checks (1 passed, 2 warnings)

❌ Failed Checks (2 warnings)

Check Name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title only mentions adding a new reference section but doesn’t reflect that the existing Knowledge Base code guidelines section was also rewritten.	Revise the title to cover both the addition of the configuration reference section and the rewrite of the Knowledge Base code guidelines—for example, "Rewrite Knowledge Base code guidelines section and add configuration reference for code guidelines."
Description Check	⚠️ Warning	The description lists the changes but lacks background, rationale, impact details, and there’s no pull request template to guide contributors.	Include the motivation and impact of the updates, link any related issues or discussions, and add a pull request template with sections for context, rationale, and testing instructions.

✅ Passed Checks (1 passed)

Check Name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch code-guidelines

---

🪧 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>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	ce65ce2
Status:	✅  Deploy successful!
Preview URL:	https://91998121.coderabbit-docs.pages.dev
Branch Preview URL:	https://code-guidelines.coderabbit-docs.pages.dev

View logs