Skip to content

docs(cli): clarify custom pricing file behavior - #1310

Open
Rainaxyz wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
Rainaxyz:codex/docs-pricing-reference
Open

Rainaxyz wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
Rainaxyz:codex/docs-pricing-reference

Conversation

@Rainaxyz

@Rainaxyz Rainaxyz commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

What

Document TOML and JSON support for --pricing-file and explain that a custom file replaces the entire bundled price table. Readers overriding one model's rates can then include the other models they still need to estimate.

Why

The CLI reference currently describes a JSON file and omits replacement behavior. The updated wording matches the loader, server configuration, and existing Pi integration guide.

Notes for reviewers

Only docs/cli_reference.md changes.

Validation on main c932cfe0be2ccb6ca98237b124b1315fbd14222b:

  • Strict MkDocs build passes; rendered pricing text checked.
  • A standalone public-API consumer loads equivalent JSON and TOML tables, verifies custom estimates and absence of bundled-only entries, and checks provider-charge precedence.
  • git diff --check passes.

Summary by CodeRabbit

  • Documentation
    • Clarified that --pricing-file accepts TOML or JSON rates in USD per million tokens.
    • Documented that routing records use bundled model prices by default, while a supplied pricing file replaces the bundled table and must include every model to be priced.

Signed-off-by: Raina Zhong <yuweiz@nvidia.com>
@Rainaxyz
Rainaxyz marked this pull request as ready for review November 13, 2026 05:14
@Rainaxyz
Rainaxyz requested a review from a team as a code owner November 13, 2026 05:14
@coderabbitai

coderabbitai Bot commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The CLI reference now documents TOML and JSON pricing files. It explains that bundled model prices apply by default and that a supplied pricing file replaces the full bundled table.

Changes

Pricing file documentation

Layer / File(s) Summary
Document pricing file behavior
docs/cli_reference.md
The --pricing-file entry now lists TOML and JSON formats. It states that bundled model prices apply by default and that a supplied file replaces the full table, so it must include every model to be priced.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: Minimal · up to 3a35f

This is a documentation-only clarification of pricing file formats and replacement behavior. It matches the existing implementation and carries no meaningful merge risk.

Architecture risk: Low · up to 3a35f

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/cli_reference.md: The --pricing-file documentation now lists TOML as well as JSON input and adds guidance that bundled model prices apply by default, while a supplied file replaces the entire table.
Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs(cli): clarify custom pricing file behavior" matches the single change in the changeset. The raw summary says docs/cli_reference.md now documents TOML/JSON support for --pricing-file an…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs(cli): clarify custom pricing file behavior" matches the single change in the changeset. The raw summary says docs/cli_reference.md now documents TOML/JSON support for --pricing-file and states that a custom pricing file replaces the entire bundled price table. The PR objectives describe the same documentation change and say the commit message is consistent with it. The title names the documented area (CLI pricing file) and the clarified behavior (replacement of the bundled table), so it is specific and accurate. It does not mention the TOML/JSON format support, but that is a secondary detail.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit reads the pricing page,
TOML and JSON take the stage.
Bundled rates are there by default,
A full new table takes their place.
Every model needs its price,
Then the rabbit hops off twice.

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between c932cfe and 3a35f94.

Files selected for processing: 1

  • docs/cli_reference.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant