docs: update inference docs - #1460
Merged
Merged
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughRemoved the legacy Changes
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (5)
docs/inference/inference-options.md (2)
77-80: Use aNext Stepssection at the bottom instead ofRelated Topics.For new pages, the bottom section should be named
Next Stepsand link related pages.
As per coding guidelines, "A 'Next Steps' section at the bottom links to related pages."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/inference/inference-options.md` around lines 77 - 80, The bottom section currently titled "Related Topics" should be renamed to "Next Steps": change the heading text "Related Topics" to "Next Steps" and keep the same links (the Ollama/vLLM/NIM local inference link and the Switch Inference Models link) so the content remains identical but follows the guideline; update the heading string in the docs/inference/inference-options.md file where "Related Topics" appears to "Next Steps" to ensure conformity with the new page convention.
46-53: Use one sentence per source line in table content.Several table cells pack multiple sentences into one line (for example, Lines 46-53). Split them so each sentence is on its own source line.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/inference/inference-options.md` around lines 46 - 53, The table rows for sources like "NVIDIA Endpoints", "OpenAI", "Other OpenAI-compatible endpoint", "Anthropic", "Other Anthropic-compatible endpoint", "Google Gemini", and "Local Ollama" contain multiple sentences on a single markdown source line; edit docs/inference/inference-options.md so each sentence in those table cells is placed on its own source line (one sentence per line) while preserving the same text content and punctuation, e.g., split the descriptive cells and examples so each sentence begins on a new line within the same table cell.docs/inference/use-local-inference.md (3)
73-73: Remove superlative phrasing (“most flexible”).Line 73 uses a superlative ("most flexible"), which reads as promotional. Replace with neutral, specific wording. LLM pattern detected.
As per coding guidelines, "Superlatives and marketing language ('powerful,' 'robust,' 'seamless,' 'cutting-edge'). Say what it does, not how great it is."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/inference/use-local-inference.md` at line 73, Replace the promotional sentence "This is the most flexible path and works with any server that implements `/v1/chat/completions`, including vLLM, TensorRT-LLM, llama.cpp, LocalAI, and others." with neutral, factual wording — e.g. "This option works with any server that implements `/v1/chat/completions`, including vLLM, TensorRT-LLM, llama.cpp, LocalAI, and others." — removing the superlative "most flexible" and keeping the compatibility details intact.
36-37: Keep one sentence per source line.Line 36 contains multiple sentences in one line. Split them so each sentence has its own line in source.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/inference/use-local-inference.md` around lines 36 - 37, The line containing "A local model server running, or Ollama installed. The NemoClaw onboard wizard can also start Ollama for you." packs two sentences on one source line; split this into two separate source lines so each sentence is its own line (first line: "A local model server running, or Ollama installed." second line: "The NemoClaw onboard wizard can also start Ollama for you."), preserving punctuation and surrounding context.
213-217: Rename bottom related-links section toNext Steps.For this new page, use a bottom
Next Stepssection for related links instead ofRelated Topics.
As per coding guidelines, "A 'Next Steps' section at the bottom links to related pages."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/inference/use-local-inference.md` around lines 213 - 217, Rename the bottom "Related Topics" section header to "Next Steps" in this document; specifically update the heading text (currently "## Related Topics") to "## Next Steps" while preserving the existing bullet links (Inference Options, Switch Inference Models, Quickstart) so only the section title changes and link targets remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/inference/inference-options.md`:
- Line 56: Replace the inaccurate sentence "The following local inference
options require the `NEMOCLAW_EXPERIMENTAL=1` environment variable and do not
appear in the selection list during onboarding." with a corrected statement that
says these options will appear in the onboarding selection when
`NEMOCLAW_EXPERIMENTAL=1` and prerequisites are met (e.g., "The following local
inference options require `NEMOCLAW_EXPERIMENTAL=1` and, when prerequisites are
met, will appear in the onboarding selection list.").
- Around line 3-23: The H1 heading at the bottom ("# Inference Options") does
not match the frontmatter page value ("NemoClaw Inference Options"); update the
H1 to exactly match the frontmatter page/title by changing the header to "#
NemoClaw Inference Options" (or alternatively change the frontmatter page field
to "Inference Options" if you intend the shorter title) so that the H1 and the
page frontmatter (page/title) are identical.
In `@docs/inference/use-local-inference.md`:
- Around line 3-23: The H1 heading does not match the frontmatter title.page
value; update the document so the H1 exactly matches the frontmatter string "Use
a Local Inference Server with NemoClaw" (change the current H1 "# Use a Local
Inference Server" to "# Use a Local Inference Server with NemoClaw") ensuring
the title.page frontmatter and the H1 are identical.
---
Nitpick comments:
In `@docs/inference/inference-options.md`:
- Around line 77-80: The bottom section currently titled "Related Topics" should
be renamed to "Next Steps": change the heading text "Related Topics" to "Next
Steps" and keep the same links (the Ollama/vLLM/NIM local inference link and the
Switch Inference Models link) so the content remains identical but follows the
guideline; update the heading string in the docs/inference/inference-options.md
file where "Related Topics" appears to "Next Steps" to ensure conformity with
the new page convention.
- Around line 46-53: The table rows for sources like "NVIDIA Endpoints",
"OpenAI", "Other OpenAI-compatible endpoint", "Anthropic", "Other
Anthropic-compatible endpoint", "Google Gemini", and "Local Ollama" contain
multiple sentences on a single markdown source line; edit
docs/inference/inference-options.md so each sentence in those table cells is
placed on its own source line (one sentence per line) while preserving the same
text content and punctuation, e.g., split the descriptive cells and examples so
each sentence begins on a new line within the same table cell.
In `@docs/inference/use-local-inference.md`:
- Line 73: Replace the promotional sentence "This is the most flexible path and
works with any server that implements `/v1/chat/completions`, including vLLM,
TensorRT-LLM, llama.cpp, LocalAI, and others." with neutral, factual wording —
e.g. "This option works with any server that implements `/v1/chat/completions`,
including vLLM, TensorRT-LLM, llama.cpp, LocalAI, and others." — removing the
superlative "most flexible" and keeping the compatibility details intact.
- Around line 36-37: The line containing "A local model server running, or
Ollama installed. The NemoClaw onboard wizard can also start Ollama for you."
packs two sentences on one source line; split this into two separate source
lines so each sentence is its own line (first line: "A local model server
running, or Ollama installed." second line: "The NemoClaw onboard wizard can
also start Ollama for you."), preserving punctuation and surrounding context.
- Around line 213-217: Rename the bottom "Related Topics" section header to
"Next Steps" in this document; specifically update the heading text (currently
"## Related Topics") to "## Next Steps" while preserving the existing bullet
links (Inference Options, Switch Inference Models, Quickstart) so only the
section title changes and link targets remain unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ed227bb2-e4d3-4be5-b12d-6aab0e86ffdf
📒 Files selected for processing (8)
docs/about/how-it-works.mddocs/index.mddocs/inference/inference-options.mddocs/inference/switch-inference-providers.mddocs/inference/use-local-inference.mddocs/reference/architecture.mddocs/reference/inference-profiles.mddocs/security/best-practices.md
💤 Files with no reviewable changes (1)
- docs/reference/inference-profiles.md
Comment on lines
+3
to
+23
| page: "NemoClaw Inference Options" | ||
| nav: "Inference Options" | ||
| description: | ||
| main: "Inference providers available during NemoClaw onboarding and how the routed inference model works." | ||
| agent: "Lists all inference providers offered during NemoClaw onboarding. Use when explaining which providers are available, what the onboard wizard presents, or how inference routing works." | ||
| keywords: ["nemoclaw inference options", "nemoclaw onboarding providers", "nemoclaw inference routing"] | ||
| topics: ["generative_ai", "ai_agents"] | ||
| tags: ["openclaw", "openshell", "inference_routing", "nemoclaw"] | ||
| content: | ||
| type: concept | ||
| difficulty: technical_beginner | ||
| audience: ["developer", "engineer"] | ||
| status: published | ||
| --- | ||
|
|
||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # Inference Options |
Contributor
There was a problem hiding this comment.
Align H1 with title.page.
Line 23 (# Inference Options) does not match Line 3 (NemoClaw Inference Options). Keep them identical for page-structure consistency.
As per coding guidelines, "H1 heading matches the title.page frontmatter value."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/inference/inference-options.md` around lines 3 - 23, The H1 heading at
the bottom ("# Inference Options") does not match the frontmatter page value
("NemoClaw Inference Options"); update the H1 to exactly match the frontmatter
page/title by changing the header to "# NemoClaw Inference Options" (or
alternatively change the frontmatter page field to "Inference Options" if you
intend the shorter title) so that the H1 and the page frontmatter (page/title)
are identical.
Comment on lines
+3
to
+23
| page: "Use a Local Inference Server with NemoClaw" | ||
| nav: "Use Local Inference" | ||
| description: | ||
| main: "Connect NemoClaw to a local model server such as Ollama, vLLM, TensorRT-LLM, or any OpenAI-compatible endpoint." | ||
| agent: "Connects NemoClaw to a local inference server. Use when setting up Ollama, vLLM, TensorRT-LLM, NIM, or any OpenAI-compatible local model server with NemoClaw." | ||
| keywords: ["nemoclaw local inference", "ollama nemoclaw", "vllm nemoclaw", "local model server", "openai compatible endpoint"] | ||
| topics: ["generative_ai", "ai_agents"] | ||
| tags: ["openclaw", "openshell", "inference_routing", "local_inference"] | ||
| content: | ||
| type: how_to | ||
| difficulty: intermediate | ||
| audience: ["developer", "engineer"] | ||
| status: published | ||
| --- | ||
|
|
||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # Use a Local Inference Server |
Contributor
There was a problem hiding this comment.
Match H1 with title.page.
Line 23 (# Use a Local Inference Server) should exactly match Line 3 (Use a Local Inference Server with NemoClaw).
As per coding guidelines, "H1 heading matches the title.page frontmatter value."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/inference/use-local-inference.md` around lines 3 - 23, The H1 heading
does not match the frontmatter title.page value; update the document so the H1
exactly matches the frontmatter string "Use a Local Inference Server with
NemoClaw" (change the current H1 "# Use a Local Inference Server" to "# Use a
Local Inference Server with NemoClaw") ensuring the title.page frontmatter and
the H1 are identical.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/conf.py`:
- Around line 32-34: Update the contributor mapping that references
"reference/inference-profiles.md" to match the new redirect entry you added to
the redirects dict (the "reference/inference-profiles" ->
"../inference/inference-options.html" mapping); locate the mapping table that
lists "reference/inference-profiles.md" and change the path or label to the new
target (or add a note about the redirect) so the contributor docs are not stale
and align with the redirects variable.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: e9ff8125-46a4-438f-8d4e-9b4a7b0999f9
⛔ Files ignored due to path filters (1)
uv.lockis excluded by!**/*.lock
📒 Files selected for processing (2)
docs/conf.pypyproject.toml
✅ Files skipped from review due to trivial changes (1)
- pyproject.toml
ericksoa
requested changes
Apr 3, 2026
ericksoa
left a comment
ericksoa
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this, Miyoung! The reorg from a single reference page into a concept page + a how-to guide is a really nice improvement — much easier for users to find what they need.
A few things I noticed that would be good to address before merging:
Broken references to the deleted page
docs/CONTRIBUTING.md(line 31) still listsdocs/reference/inference-profiles.mdas a skill source — this will be a dead reference after merge. Could you update it to point to the new pages?README.md(line 143) still links toreference/inference-profiles.html. The Sphinx redirect covers the built site, but it'd be nice to update the README to the canonical URL too.- The agent skills (
.agents/skills/nemoclaw-reference/SKILL.md) still reference the old file. Would you mind runningpython scripts/docs-to-skills.py docs/ .agents/skills/docs/ --prefix nemoclawto regenerate them?
Minor wording suggestions
- In
inference-options.md(~line 56), the sentence says experimental options "do not appear in the selection list during onboarding" — but they do appear whenNEMOCLAW_EXPERIMENTAL=1is set and prerequisites are met. Maybe something like: "requireNEMOCLAW_EXPERIMENTAL=1and, when set, appear in the onboarding selection list"? - In
use-local-inference.md(~line 73), "the most flexible path" reads a bit like marketing — could we swap it for something more concrete, like "works with any server that implements/v1/chat/completions"? - The docs style guide recommends "Next Steps" over "Related Topics" for new pages — worth updating on both new files if you're already making changes.
Really solid work overall — the content is thorough and the redirect setup is clean. Just those reference updates and we should be good to go!
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
.agents/skills/nemoclaw-configure-inference/SKILL.md (1)
3-321:⚠️ Potential issue | 🟠 MajorEdit source docs, not autogenerated skill artifacts.
This file is generated; direct edits here will be overwritten and can drift from the docs source of truth. Please move these changes to the corresponding
docs/pages and regenerate skills viascripts/docs-to-skills.py.As per coding guidelines, "Never edit .agents/skills/nemoclaw-/.md files directly; they are autogenerated from docs/ via scripts/docs-to-skills.py".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/nemoclaw-configure-inference/SKILL.md around lines 3 - 321, The SKILL.md under .agents/skills/nemoclaw-configure-inference is autogenerated and should not be edited directly; instead make your content changes in the canonical docs source under docs/ (the corresponding page for "nemoclaw-configure-inference"), then regenerate the skill artifact using the scripts/docs-to-skills.py script so the update flows into SKILL.md; search for the "nemoclaw-configure-inference" docs page and run scripts/docs-to-skills.py to produce the updated .agents/skills/nemoclaw-configure-inference/SKILL.md rather than committing edits to SKILL.md itself..agents/skills/nemoclaw-deploy-remote/SKILL.md (1)
78-172:⚠️ Potential issue | 🔴 CriticalDo not edit autogenerated skill files directly.
This file is autogenerated from source documentation via
scripts/docs-to-skills.py. Direct edits to files in.agents/skills/nemoclaw-*/will be overwritten when the generation script runs and will create inconsistencies between the source docs and generated skills.Please apply these changes to the source documentation files in the
docs/directory instead, then regenerate the skill files usingscripts/docs-to-skills.py.As per coding guidelines: "Never edit .agents/skills/nemoclaw-/.md files directly; they are autogenerated from docs/ via scripts/docs-to-skills.py"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/nemoclaw-deploy-remote/SKILL.md around lines 78 - 172, The SKILL.md file is autogenerated; do not edit .agents/skills/nemoclaw-deploy-remote/SKILL.md directly — instead make your changes in the corresponding source documentation under docs/ (update the relevant document that produces the "Step 6"–"Step 14" sections), then regenerate the skill files by running scripts/docs-to-skills.py so the .agents/skills/nemoclaw-*/*.md files are updated consistently; avoid committing edits directly to SKILL.md to prevent overwrite and inconsistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In @.agents/skills/nemoclaw-configure-inference/SKILL.md:
- Around line 3-321: The SKILL.md under
.agents/skills/nemoclaw-configure-inference is autogenerated and should not be
edited directly; instead make your content changes in the canonical docs source
under docs/ (the corresponding page for "nemoclaw-configure-inference"), then
regenerate the skill artifact using the scripts/docs-to-skills.py script so the
update flows into SKILL.md; search for the "nemoclaw-configure-inference" docs
page and run scripts/docs-to-skills.py to produce the updated
.agents/skills/nemoclaw-configure-inference/SKILL.md rather than committing
edits to SKILL.md itself.
In @.agents/skills/nemoclaw-deploy-remote/SKILL.md:
- Around line 78-172: The SKILL.md file is autogenerated; do not edit
.agents/skills/nemoclaw-deploy-remote/SKILL.md directly — instead make your
changes in the corresponding source documentation under docs/ (update the
relevant document that produces the "Step 6"–"Step 14" sections), then
regenerate the skill files by running scripts/docs-to-skills.py so the
.agents/skills/nemoclaw-*/*.md files are updated consistently; avoid committing
edits directly to SKILL.md to prevent overwrite and inconsistency.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ae9f79cc-5ae9-4094-8b63-2ae2320cab06
📒 Files selected for processing (11)
.agents/skills/nemoclaw-configure-inference/SKILL.md.agents/skills/nemoclaw-configure-inference/references/inference-options.md.agents/skills/nemoclaw-deploy-remote/SKILL.md.agents/skills/nemoclaw-overview/references/how-it-works.md.agents/skills/nemoclaw-reference/SKILL.md.agents/skills/nemoclaw-reference/references/architecture.md.agents/skills/nemoclaw-security-best/references/best-practices.mdREADME.mddocs/CONTRIBUTING.mddocs/inference/inference-options.mddocs/inference/use-local-inference.md
✅ Files skipped from review due to trivial changes (9)
- .agents/skills/nemoclaw-security-best/references/best-practices.md
- README.md
- .agents/skills/nemoclaw-overview/references/how-it-works.md
- .agents/skills/nemoclaw-reference/references/architecture.md
- .agents/skills/nemoclaw-reference/SKILL.md
- docs/CONTRIBUTING.md
- .agents/skills/nemoclaw-configure-inference/references/inference-options.md
- docs/inference/inference-options.md
- docs/inference/use-local-inference.md
ericksoa
approved these changes
Apr 3, 2026
ericksoa
left a comment
ericksoa
left a comment
Contributor
There was a problem hiding this comment.
All six items addressed — nice work, Miyoung! The references are updated, skills regenerated, wording is clear, and both new pages use "Next Steps." LGTM, approving.
gemini2026
pushed a commit
to gemini2026/NemoClaw
that referenced
this pull request
Apr 14, 2026
<!-- markdownlint-disable MD041 --> ## Summary <!-- 1-3 sentences: what this PR does and why. --> ## Related Issue <!-- Link to the issue: Fixes #NNN or Closes #NNN. Remove this section if none. --> ## Changes <!-- Bullet list of key changes. --> ## Type of Change <!-- Check the one that applies. --> - [ ] Code change for a new feature, bug fix, or refactor. - [ ] Code change with doc updates. - [x] Doc only. Prose changes without code sample modifications. - [ ] Doc only. Includes code sample changes. ## Testing <!-- What testing was done? --> - [ ] `npx prek run --all-files` passes (or equivalently `make check`). - [ ] `npm test` passes. - [x] `make docs` builds without warnings. (for doc-only changes) ## Checklist ### General - [x] I have read and followed the [contributing guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md). - [x] I have read and followed the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). (for doc-only changes) ### Code Changes <!-- Skip if this is a doc-only PR. --> - [ ] Formatters applied — `npx prek run --all-files` auto-fixes formatting (or `make format` for targeted runs). - [ ] Tests added or updated for new or changed behavior. - [x] No secrets, API keys, or credentials committed. - [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs). ### Doc Changes <!-- Skip if this PR has no doc changes. --> - [x] Follows the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR." - [x] New pages include SPDX license header and frontmatter, if creating a new page. - [x] Cross-references and links verified. --- <!-- DCO sign-off (required by CI). Replace with your real name and email. --> Signed-off-by: Your Name <your-email@example.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added “Inference Options” and “Use Local Inference” guides covering provider selection, onboarding flows, local provider setup, validation checks, experimental local options, and runtime model switching. * Reorganized inference content and navigation; removed the old “Inference Profiles” page and updated related links and landing-page cards. * Added redirects so previous inference links forward to the new guidance and enabled redirect support in the docs build. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
wscurran
added
area: docs
12 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Related Issue
Changes
Type of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)Checklist
General
Code Changes
npx prek run --all-filesauto-fixes formatting (ormake formatfor targeted runs).Doc Changes
update-docsagent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docscatch up the docs for the new changes I made in this PR."Signed-off-by: Your Name your-email@example.com
Summary by CodeRabbit