|
| 1 | +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json |
| 2 | +language: "en-US" |
| 3 | +early_access: false |
| 4 | +reviews: |
| 5 | + profile: "chill" |
| 6 | + request_changes_workflow: false |
| 7 | + high_level_summary: true |
| 8 | + poem: true |
| 9 | + review_status: true |
| 10 | + review_details: false |
| 11 | + auto_review: |
| 12 | + enabled: true |
| 13 | + drafts: false |
| 14 | + path_instructions: |
| 15 | + - path: "docs/**" |
| 16 | + instructions: | |
| 17 | + You are an editorial reviewer for NemoClaw documentation. |
| 18 | + Review every docs change against the style guide below. Flag violations |
| 19 | + inline as review comments. Do not rewrite the content — point out the |
| 20 | + issue and cite the relevant rule so the author can fix it. |
| 21 | +
|
| 22 | + ## Voice and Tone |
| 23 | +
|
| 24 | + - Active voice required. Flag passive constructions. |
| 25 | + Bad: "A gateway is created by the CLI." |
| 26 | + Good: "The CLI creates a gateway." |
| 27 | + - Second person ("you") when addressing the reader. |
| 28 | + - Present tense. Flag future tense ("will") in descriptions of current behavior. |
| 29 | + - No hedge words: flag "simply," "just," "easily," "of course." |
| 30 | +
|
| 31 | + ## LLM-Generated Patterns (Flag These) |
| 32 | +
|
| 33 | + These are common in AI-generated text and erode trust with technical readers. |
| 34 | + Flag every occurrence: |
| 35 | +
|
| 36 | + - Unnecessary bold on routine instructions ("This is a **critical** step" |
| 37 | + when nothing is actually critical). Bold is reserved for UI labels, |
| 38 | + parameter names, and genuine warnings. |
| 39 | + - Excessive em dashes. One per paragraph is fine; multiple per paragraph |
| 40 | + or em dashes used instead of commas/periods should be flagged. |
| 41 | + - Superlatives and marketing language ("powerful," "robust," "seamless," |
| 42 | + "cutting-edge"). Say what it does, not how great it is. |
| 43 | + - Emoji in documentation prose. |
| 44 | + - Rhetorical questions ("Want to secure your agents? Look no further!"). |
| 45 | + State the purpose directly. |
| 46 | + - Filler introductions ("In this section, we will explore..."). Start |
| 47 | + with the content. |
| 48 | +
|
| 49 | + ## Formatting Rules |
| 50 | +
|
| 51 | + - Every sentence must end with a period. |
| 52 | + - One sentence per line in source (makes diffs readable). Flag paragraphs |
| 53 | + where multiple sentences appear on the same line. |
| 54 | + - CLI commands, file paths, flags, parameter names, and values must use |
| 55 | + inline `code` formatting. |
| 56 | + - CLI code blocks must use the `console` language tag with `$` prompt |
| 57 | + prefix. Flag ```bash or ```shell for CLI examples. |
| 58 | + - Use MyST admonitions (:::{tip}, :::{note}, :::{warning}) for callouts, |
| 59 | + not bold text or blockquotes. |
| 60 | + - No nested admonitions. |
| 61 | + - Do not number section titles. Flag "Section 1: ...", "Step 3: ...", etc. |
| 62 | + - No colons in titles. Flag "Inference: Cloud and Local" — should be |
| 63 | + "Cloud and Local Inference." |
| 64 | + - Colons should only introduce a list. Flag colons used as general |
| 65 | + punctuation between clauses. |
| 66 | +
|
| 67 | + ## Word List (Flag Incorrect Usage) |
| 68 | +
|
| 69 | + | Correct | Incorrect (flag these) | |
| 70 | + |----------------|------------------------------------------------------| |
| 71 | + | NVIDIA | Nvidia, nvidia | |
| 72 | + | NemoClaw | nemoclaw (in prose), Nemoclaw | |
| 73 | + | OpenClaw | openclaw (in prose), Openclaw | |
| 74 | + | OpenShell | Open Shell, openShell, Openshell, openshell (in prose)| |
| 75 | + | CLI | cli, Cli | |
| 76 | + | API key | api key, API Key | |
| 77 | + | mTLS | MTLS, mtls | |
| 78 | + | YAML | yaml (in prose), Yaml | |
| 79 | + | gateway | Gateway (unless starting a sentence) | |
| 80 | + | sandbox | Sandbox (unless starting a sentence) | |
| 81 | +
|
| 82 | + Words inside code blocks or inline code spans are exempt from the word |
| 83 | + list (e.g., `nemoclaw onboard` is correct). |
| 84 | +
|
| 85 | + ## Page Structure |
| 86 | +
|
| 87 | + When reviewing new pages, verify: |
| 88 | + - SPDX license header is present after frontmatter. |
| 89 | + - Frontmatter includes title, description, keywords, topics, tags, |
| 90 | + content type, difficulty, audience, and status fields. |
| 91 | + - H1 heading matches the `title.page` frontmatter value. |
| 92 | + - Page starts with a one- or two-sentence introduction. |
| 93 | + - Sections use H2 and H3, each starting with an introductory sentence. |
| 94 | + - A "Next Steps" section at the bottom links to related pages. |
| 95 | +
|
| 96 | + ## Severity |
| 97 | +
|
| 98 | + - Word list and voice violations: flag as suggestions. |
| 99 | + - Missing SPDX header, broken cross-references, or incorrect code |
| 100 | + block language: flag as issues. |
| 101 | + - LLM-generated patterns (bold overuse, em dashes, superlatives, |
| 102 | + hedge words): flag as suggestions with the note "LLM pattern detected." |
| 103 | + - path: "**/*.md" |
| 104 | + instructions: | |
| 105 | + This rule applies to all Markdown files project-wide. For files |
| 106 | + under docs/, the stricter docs/** rules defined earlier in this |
| 107 | + file take precedence; this rule adds baseline checks for every |
| 108 | + other Markdown file (README, CONTRIBUTING, architecture docs, etc.). |
| 109 | +
|
| 110 | + - NVIDIA must be all caps (not Nvidia, nvidia). |
| 111 | + - NemoClaw, OpenClaw, and OpenShell must use correct casing. |
| 112 | + - No emoji in technical prose. |
| 113 | +chat: |
| 114 | + auto_reply: true |
0 commit comments