Add a config template file to the docs.

[jmacdotorg]

Adds a .coderabbit.yaml config file to the docs.

[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 64be92a and d9249be.

📒 Files selected for processing (3)

• docs/getting-started/configure-coderabbit.md (1 hunks)
• docs/reference/yaml-template.md (1 hunks)
• sidebars.ts (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/reference/yaml-template.md

145-145: Hard tabs
Column: 1

(MD010, no-hard-tabs)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (2)

docs/reference/yaml-template.md (1)

136-140: ```shell
#!/bin/bash

List all files in docs/tools to locate slug filenames

echo "=== docs/tools directory listing ==="
ls -1 docs/tools

echo -e "\n=== Files containing 'shopify' ==="
ls -1 docs/tools | grep -i shopify || true

echo -e "\n=== Files containing 'prisma' ==="
ls -1 docs/tools | grep -i prisma || true

</details>
<details>
<summary>sidebars.ts (1)</summary>

`160-171`: **Link added correctly – verify slug resolves**

`"reference/yaml-template"` is inserted after `"reference/configuration"`, LGTM.  
Run `npm run docusaurus build` to confirm no 404 is generated and that the item appears in the expected order.

</details>

</blockquote></details>

Walkthrough

The documentation was updated to remove an inline YAML configuration example from the getting started guide, replacing it with a reference link to a new, comprehensive YAML template documentation page. The sidebar configuration was also updated to include this new template page under the Reference section.

Changes

File(s)	Change Summary
docs/getting-started/configure-coderabbit.md	Replaced embedded sample YAML with a hyperlink to the new configuration template documentation.
docs/reference/yaml-template.md	Added a new documentation file providing a full .coderabbit.yaml configuration template and details.
sidebars.ts	Added the new template documentation page to the Reference section of the sidebar.

Poem

In docs we hop, from page to page,
A template born upon the stage.
No more snippets lost in text,
A link now guides you to the next.
Sidebar fresh, the path is clear—
CodeRabbit’s docs bring cheer!
🐇📄✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch template

---

🪧 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.
  • @coderabbitai modularize this function.
• 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @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 auto-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.

[jmacdotorg]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.