Add code_guidelines to the sample YAML.

[jmacdotorg]

No description provided.

[coderabbitai]

Walkthrough

The changes update a YAML configuration template by replacing single quotes with double quotes for all string values, restructuring the htmlhint configuration from a boolean to an object, and introducing a new code_guidelines section under knowledge_base. Minor formatting adjustments were also made for consistency.

Changes

File(s)	Change Summary
docs/reference/yaml-template.md	Replaced single quotes with double quotes in all string values; restructured htmlhint config as an object; added code_guidelines section under knowledge_base; adjusted formatting for clarity.

Poem

In the land of YAML, quotes now gleam,
Double marks replace the single theme.
New guidelines hop beneath the base,
And htmlhint finds its nesting place.
With tidy lines and clearer hue,
This bunny cheers, “A doc renewed!” 🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch guideline-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.

[smb06]

LGTM

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

92-92: Empty config_file values – consider adding guidance

Several tool sections now expose a config_file key with an empty string. Readers may wonder whether
• an empty string means “use default discovery”, or
• they must supply a path.

Suggest adding a short comment in the template or in the surrounding docs clarifying the intended behaviour, e.g.:

swiftlint:
  enabled: true
  # config_file: ""  # leave blank to let CodeRabbit/SwiftLint auto-discover

Also applies to: 98-98, 107-107, 120-120, 125-125

---

162-164: New code_guidelines section – give users a jump-start

Nice addition. Two quick wins:

 code_guidelines:
   enabled: true
-  filePatterns: []
+  # e.g. ["docs/code_guidelines/*.md"]
+  filePatterns: []

An example pattern helps new users understand the field’s purpose immediately.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4e961df and 0a7907f.

📒 Files selected for processing (1)

• docs/reference/yaml-template.md (8 hunks)

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

• GitHub Check: test

🔇 Additional comments (8)

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

17-17: Consistent quoting looks good

Switching to double quotes keeps the template consistent with YAML best-practices.

---

24-24: Placeholder quote-style aligned

No issues – change is purely cosmetic.

---

26-27: Uniform placeholder formatting

Same remark – swapping quote styles is fine.

---

43-44: Label/instruction placeholders now consistent

Looks good.

---

47-48: Path-level placeholders updated

Change is harmless; template remains valid YAML.

---

146-148: htmlhint re-shaped to object – ensure schema bump

Great move for parity with other linters. Double-check that:

1. The public JSON schema (schema.v2.json) has been updated to reflect the new object shape.
2. Existing repositories using the old boolean variant will continue to validate (e.g. via oneOf in the schema).

---

181-182: Docstring path placeholders – cosmetic change only

No concerns.

---

185-186: Unit-test path placeholders – cosmetic change only

All good.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	0a7907f
Status:	✅  Deploy successful!
Preview URL:	https://8730ab7e.coderabbit-docs.pages.dev
Branch Preview URL:	https://guideline-template.coderabbit-docs.pages.dev

View logs