Skip to content

docs: document the opt-in response cache (stage 1/5)#405

Draft
zhongxuanwang-nv wants to merge 1 commit into
NVIDIA:mainfrom
zhongxuanwang-nv:docs/response-cache-stage1
Draft

docs: document the opt-in response cache (stage 1/5)#405
zhongxuanwang-nv wants to merge 1 commit into
NVIDIA:mainfrom
zhongxuanwang-nv:docs/response-cache-stage1

Conversation

@zhongxuanwang-nv

@zhongxuanwang-nv zhongxuanwang-nv commented Jul 10, 2026

Copy link
Copy Markdown
Member

Overview

Documents the feature in #404 — the branch is based directly on main, so the diff here is the documentation change only and can be reviewed standalone. Kept in draft only so it merges after #404 (the page should not land before the feature it documents).

Documents the opt-in response cache on the documentation site: a new Response Cache page in the Adaptive plugin section, written in plain language with runnable examples — when to use it, a plugins.toml quickstart, per-language plugin configuration (Python/Node.js/Rust), what gets cached (complete answers only, streaming aggregation and native replay), how cache keys are built, observability (nemo-relay doctor, response_cache marks), a full field reference, and the unredacted-at-rest caveat for shared Redis deployments. Docs PR 1/5 of the response-cache series.

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

  • Adds docs/configure-plugins/adaptive/response-cache.mdx (position 5 in the Adaptive plugin section), following the ACG page skeleton: intro → When To Use It → plugins.toml example → Plugin Configuration tabs → Manual API tabs → What Gets Cached → Cache Keys → Observability → Fields → Common Validation Failures.
  • Cross-links the new page from docs/configure-plugins/adaptive/about.mdx (coordination list and Pages list) and docs/configure-plugins/adaptive/configuration.mdx (Component Shape table and area-pages paragraph).
  • No README changes: feature documentation lives on the docs site alongside the other adaptive plugin feature pages.
  • Validated with fern check and fern docs broken-links --strict (the only reported broken links are the pre-existing generated API-reference pages, regenerated by just docs).

Where should the reviewer start?

docs/configure-plugins/adaptive/response-cache.mdx — the page is the whole change (one commit, docs files only).

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: b07b5575-3ecb-4e99-aaeb-b4978bcbf2fe

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added size:XXL PR is very large Documentation documentation-related lang:go PR changes/introduces Go code lang:js PR changes/introduces Javascript/Typescript code lang:python PR changes/introduces Python code lang:rust PR changes/introduces Rust code labels Jul 10, 2026
@github-actions

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Jul 11, 2026

Copy link
Copy Markdown

License Diff

Compared against origin/main.

Lockfile license changes

Lockfile License Changes

Rust

Added

  • None

Removed

  • None

Updated/Changed

  • None

Node

Added

  • None

Removed

  • None

Updated/Changed

  • None

Python

Added

  • None

Removed

  • None

Updated/Changed

  • None
Status output
[license-diff] selected languages: rust, node, python
[license-diff] generating current inventory
[license-diff] current: generating Rust inventory
[license-diff] current: Rust inventory complete (379 packages)
[license-diff] current: generating Node inventory
[license-diff] current: Node inventory complete (363 packages)
[license-diff] current: generating Python inventory
[license-diff] current: Python inventory complete (105 packages)
[license-diff] current inventory complete
[license-diff] checking out base ref origin/main into a temporary worktree
[license-diff] base: generating Rust inventory
[license-diff] base: Rust inventory complete (379 packages)
[license-diff] base: generating Node inventory
[license-diff] base: Node inventory complete (363 packages)
[license-diff] base: generating Python inventory
[license-diff] base: Python inventory complete (105 packages)
[license-diff] base inventory complete
[license-diff] removing temporary base worktree
[license-diff] comparing inventories
[license-diff] rendering Markdown output
[license-diff] done

@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from be2d512 to fa77ecb Compare July 11, 2026 00:55
@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from fa77ecb to 1e7cafa Compare July 11, 2026 01:09
@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from 1e7cafa to c381f1f Compare July 13, 2026 15:47
@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from c381f1f to d1089ab Compare July 13, 2026 23:57
@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from d1089ab to f369cd2 Compare July 14, 2026 01:21
@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from f369cd2 to bb99464 Compare July 14, 2026 04:57
@zhongxuanwang-nv zhongxuanwang-nv force-pushed the docs/response-cache-stage1 branch from bb99464 to 2b4a5e8 Compare July 14, 2026 20:34
@github-actions github-actions Bot added size:M PR is medium and removed size:XXL PR is very large lang:go PR changes/introduces Go code lang:js PR changes/introduces Javascript/Typescript code lang:python PR changes/introduces Python code lang:rust PR changes/introduces Rust code labels Jul 14, 2026
Adds a Response Cache page to the adaptive plugin docs: when to use it,
a plugins.toml quickstart, per-language plugin configuration, the
complete-answers-only storage rules with streaming aggregation and
native replay, exact-request key normalization, the response_cache mark
and doctor surfaces, a field reference, and the unredacted-at-rest
caveat for shared Redis deployments. Links the page from the adaptive
About and Configuration pages.

Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:M PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant