[codex] docs: add inference model task-fit guide#5527
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a "Model Task-Fit Guide" section to ChangesModel Task-Fit Guide
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
HOYALIM
force-pushed
the
codex/issue-4755-task-fit-docs
branch
from
2e4efbc to
fa25f95
Compare
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds and validates a new “Model Task-Fit Guide” section in the inference options docs to keep curated onboarding model guidance up to date.
Changes:
- Added a “Model Task-Fit Guide” comparison table to
docs/inference/inference-options.mdx. - Added a Vitest that ensures the section exists, has no TBD/TODO markers, and includes rows for curated onboarding models plus select additional model IDs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| test/inference-options-docs.test.ts | Adds a docs integrity test that locates the new section and asserts required table content/model rows. |
| docs/inference/inference-options.mdx | Introduces the new model task-fit comparison table and supporting guidance text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| const repoRoot = path.dirname(import.meta.dirname); | ||
| const inferenceOptionsPath = path.join(repoRoot, "docs", "inference", "inference-options.mdx"); | ||
| const inferenceConfigPath = path.join(repoRoot, "src", "lib", "inference", "config.ts"); |
| function readCuratedNvidiaModelIds(): string[] { | ||
| const config = fs.readFileSync(inferenceConfigPath, "utf8"); | ||
| const match = config.match(/export const CLOUD_MODEL_OPTIONS = \[(?<body>[\s\S]*?)\];/); | ||
| expect(match?.groups?.body).toBeTruthy(); | ||
| return [...match!.groups!.body.matchAll(/id:\s*"([^"]+)"/g)].map((entry) => entry[1]); | ||
| } |
| return markdown.slice(start, end); | ||
| } | ||
|
|
||
| function readCuratedNvidiaModelIds(): string[] { |
HOYALIM
force-pushed
the
codex/issue-4755-task-fit-docs
branch
from
fa25f95 to
704865e
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/inference/inference-options.mdx (1)
100-100: 💤 Low valueConsider replacing "Very large context" with a stronger descriptor.
The phrase "Very large context" appears on lines 100 and 103. Per the coding guidelines, avoid weak intensifiers like "very" in documentation. Since this table lacks specific numeric context-window values (by design, per PR objectives), consider alternatives such as:
Largest contextExtensive contextMaximum contextThese provide the same meaningful distinction from the "Large context" tier without relying on the weak intensifier "very."
Also applies to: 103-103
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/inference/inference-options.mdx` at line 100, The table contains the weak intensifier "very" in the context window descriptions listed as "Very large context" which appears multiple times in the inference options table. Replace all instances of "Very large context" with a stronger descriptor such as "Largest context", "Extensive context", or "Maximum context" to align with documentation guidelines that avoid weak intensifiers while maintaining the same meaningful distinction from the "Large context" tier.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/inference/inference-options.mdx`:
- Line 100: The table contains the weak intensifier "very" in the context window
descriptions listed as "Very large context" which appears multiple times in the
inference options table. Replace all instances of "Very large context" with a
stronger descriptor such as "Largest context", "Extensive context", or "Maximum
context" to align with documentation guidelines that avoid weak intensifiers
while maintaining the same meaningful distinction from the "Large context" tier.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: a8065e5f-755f-456b-add4-7748b09eb023
📒 Files selected for processing (2)
docs/inference/inference-options.mdxtest/inference-options-docs.test.ts
Summary
Validation
python3 scripts/generate-platform-docs.py --checkNODE_PATH=/Users/holim/code/NemoClaw/node_modules /Users/holim/code/NemoClaw/node_modules/.bin/vitest run test/docs-copyable-command-blocks.test.ts test/inference-options-docs.test.tsFixes #4755
Summary by CodeRabbit
Documentation
Tests