docs: few more updates after PR 648

[miyoungc]

Summary

Few more updates after #648

Related Issue

Changes

Type of Change

• Code change for a new feature, bug fix, or refactor.
• Code change with doc updates.
• Doc only. Prose changes without code sample modifications.
• Doc only. Includes code sample changes.

Testing

• npx prek run --all-files passes (or equivalently make check).
• npm test passes.
• make docs builds without warnings. (for doc-only changes)

Checklist

General

• I have read and followed the contributing guide.
• I have read and followed the style guide. (for doc-only changes)

Code Changes

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

• Follows the style guide. 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."
• New pages include SPDX license header and frontmatter, if creating a new page.
• Cross-references and links verified.

Summary by CodeRabbit

• Documentation
  • Updated inference profiles documentation to clarify local Ollama availability and distinguish experimental local providers.
  • Updated installation guide to reflect support for multiple inference providers and their API key requirements.

[coderabbitai]

📝 Walkthrough

Walkthrough

Two documentation files were updated to clarify inference provider configurations. One file restructures local provider documentation and adds an experimental providers section, while the other generalizes API key prerequisites from NVIDIA-specific to provider-agnostic requirements with examples across multiple vendors.

Changes

Cohort / File(s)	Summary
Inference Profile Documentation docs/reference/inference-profiles.md	Replaced generic "Local Providers" section with specific "Local Ollama" section describing standard onboarding. Relocated Local NVIDIA NIM and Local vLLM to new "Experimental Local Providers" section gated by NEMOCLAW_EXPERIMENTAL=1 environment variable, including specific requirements for each provider.
Installation Prerequisites spark-install.md	Generalized API key requirement from NVIDIA-specific to provider-agnostic language. Updated onboarding wizard description to mention inference provider selection with examples: NVIDIA (build.nvidia.com), OpenAI, Anthropic, and Gemini.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Poem

🐰 Hop along with clearer paths,
Ollama in the light at last!
Experimental gardens grow,
Provider choices steal the show,
Docs bloom bright, no more in dark—
CodeRabbit leaves its helpful mark! 🌟

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is vague and generic, referencing only 'few more updates after PR 648' without indicating what those updates are or their significance.	Provide a more descriptive title that clearly indicates the main changes, such as 'docs: reorganize inference profiles and update installer prerequisites' to give reviewers immediate understanding of the changeset.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/update-installer-steps

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (2)

docs/reference/inference-profiles.md (1)

83-84: Add terminal periods to the bullet sentences.

Lines 83-84 are sentence-style bullets and should end with periods.

Proposed punctuation fix

-- Local NVIDIA NIM (requires a NIM-capable GPU)
-- Local vLLM (must already be running on `localhost:8000`)
+- Local NVIDIA NIM (requires a NIM-capable GPU).
+- Local vLLM (must already be running on `localhost:8000`).

As per coding guidelines, "Every sentence must end with a period."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/reference/inference-profiles.md` around lines 83 - 84, Add terminal
periods to the sentence-style bullets in the inference-profiles documentation:
change the two bullet lines "Local NVIDIA NIM (requires a NIM-capable GPU)" and
"Local vLLM (must already be running on `localhost:8000`)" to end with periods.
Also scan the surrounding section for other sentence-style bullets (e.g.,
similar list items) and ensure each ends with a period to comply with the "Every
sentence must end with a period" guideline.

spark-install.md (1)

10-10: Split Line 10 into one sentence per line.

Line 10 currently places multiple sentences on one source line, which makes diffs harder to review in docs.

Proposed doc-format fix

-- **API key** for your chosen inference provider. The onboarding wizard prompts for provider and key during setup. For example, you need to provide an NVIDIA API key from [build.nvidia.com](https://build.nvidia.com) for NVIDIA Endpoints, or an OpenAI, Anthropic, or Gemini key for those corresponding providers.
+- **API key** for your chosen inference provider.
+- The onboarding wizard prompts for provider and key during setup.
+- For example, you need to provide an NVIDIA API key from [build.nvidia.com](https://build.nvidia.com) for NVIDIA Endpoints, or an OpenAI, Anthropic, or Gemini key for those corresponding providers.

As per coding guidelines, "One sentence per line in source (makes diffs readable)."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@spark-install.md` at line 10, Split the single long source line that begins
with "**API key** for your chosen inference provider. The onboarding wizard
prompts for provider and key during setup. For example, you need to provide an
NVIDIA API key from https://build.nvidia.com for NVIDIA Endpoints, or an OpenAI,
Anthropic, or Gemini key for those corresponding providers." into separate
source lines so each sentence is on its own line (e.g., one line for the API key
statement, one line for the onboarding wizard prompt, and one line for the
example provider keys).

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/reference/inference-profiles.md`:
- Around line 83-84: Add terminal periods to the sentence-style bullets in the
inference-profiles documentation: change the two bullet lines "Local NVIDIA NIM
(requires a NIM-capable GPU)" and "Local vLLM (must already be running on
`localhost:8000`)" to end with periods. Also scan the surrounding section for
other sentence-style bullets (e.g., similar list items) and ensure each ends
with a period to comply with the "Every sentence must end with a period"
guideline.

In `@spark-install.md`:
- Line 10: Split the single long source line that begins with "**API key** for
your chosen inference provider. The onboarding wizard prompts for provider and
key during setup. For example, you need to provide an NVIDIA API key from
https://build.nvidia.com for NVIDIA Endpoints, or an OpenAI, Anthropic, or
Gemini key for those corresponding providers." into separate source lines so
each sentence is on its own line (e.g., one line for the API key statement, one
line for the onboarding wizard prompt, and one line for the example provider
keys).

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d66f32f9-79bc-4c04-a717-7e3b9f0d3dbf

📥 Commits

Reviewing files that changed from the base of the PR and between bb8ba78 and 363137f.

📒 Files selected for processing (2)

• docs/reference/inference-profiles.md
• spark-install.md