Skip to content

fix(docs): update version requirements for cost control#2659

Merged
ysmolski merged 2 commits intomainfrom
yury/fix_cc_doc
Mar 17, 2026
Merged

fix(docs): update version requirements for cost control#2659
ysmolski merged 2 commits intomainfrom
yury/fix_cc_doc

Conversation

@ysmolski
Copy link
Copy Markdown
Contributor

@ysmolski ysmolski commented Mar 17, 2026

Summary by CodeRabbit

  • Documentation
    • Updated cost control docs to replace the previous warning with a "Minimum requirements" section that presents router and composition minimum versions in a clear two-column table.
  • Chores
    • CI configuration updated so pull requests touching the documentation now trigger the repository's workflow.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 959e1f1a-ca48-4e63-8d21-9951ca23b648

📥 Commits

Reviewing files that changed from the base of the PR and between 8fba189 and 0a46793.

📒 Files selected for processing (1)
  • .github/workflows/dummy-ci.yaml

Walkthrough

Replaced a deprecation-style warning in the cost-control security doc with a new "Minimum requirements" section (table of router and composition versions), and added docs-website/** to pull_request triggers in a CI workflow. No code or public API changes.

Changes

Cohort / File(s) Summary
Documentation Update
docs-website/router/security/cost-control.mdx
Replaced deprecation warning block with a "Minimum requirements" section containing a two-column table of minimum router and composition versions. (+6 / -3 lines)
CI Workflow
.github/workflows/dummy-ci.yaml
Added docs-website/** to pull_request trigger paths so the workflow runs on changes under docs-website. (+1 / -0 lines)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately describes the main change: updating documentation for version requirements related to cost control.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

📝 Coding Plan
  • Generate coding plan for human review comments

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

Copy link
Copy Markdown
Member

@Aenimus Aenimus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs-website/router/security/cost-control.mdx (1)

11-12: Consider adding an internal docs cross-link in this section

Alongside release-tag links, add one internal reference (for example, upgrade/changelog docs) so users can continue navigation within docs-website.

As per coding guidelines "Link between related documentation pages using internal references".

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs-website/router/security/cost-control.mdx` around lines 11 - 12, Add an
internal docs cross-link next to the existing release-tag rows for "router" and
"composition" in docs-website/router/security/cost-control.mdx: insert an
additional table row or a short sentence immediately after those two rows that
points to the internal upgrade/changelog or related docs page using the site’s
internal MDX link format (so users can navigate within the docs-website), making
sure the link text is descriptive and follows the "Link between related
documentation pages using internal references" guideline.
🤖 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-website/router/security/cost-control.mdx`:
- Around line 11-12: Add an internal docs cross-link next to the existing
release-tag rows for "router" and "composition" in
docs-website/router/security/cost-control.mdx: insert an additional table row or
a short sentence immediately after those two rows that points to the internal
upgrade/changelog or related docs page using the site’s internal MDX link format
(so users can navigate within the docs-website), making sure the link text is
descriptive and follows the "Link between related documentation pages using
internal references" guideline.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2c721e3e-d330-41aa-9d19-ca234b9c55e8

📥 Commits

Reviewing files that changed from the base of the PR and between 2cceeb9 and 8fba189.

📒 Files selected for processing (1)
  • docs-website/router/security/cost-control.mdx

@ysmolski ysmolski merged commit 79dded9 into main Mar 17, 2026
11 checks passed
@ysmolski ysmolski deleted the yury/fix_cc_doc branch March 17, 2026 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants