fix docs release version and coverage - #345
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (3)
💤 Files with no reviewable changes (2)
📜 Recent review details⏰ Context from checks skipped due to timeout. (3)
🧰 Additional context used📓 Path-based instructions (2)docs/source/**/*📄 CodeRabbit inference engine (AGENTS.md)
Files:
{docs/**,README.md,CONTRIBUTING.md,SECURITY.md,CODE-OF-CONDUCT.md}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (1)
WalkthroughDocumentation and release metadata were updated for the AI-Q 2.2.0 candidate, covering You.com, Nimble, Azure AI Search, MCP configuration, Sphinx version sourcing, provider setup, troubleshooting, release notes, and validation settings. ChangesDocumentation and release updates
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
d90992e to
8f9f437
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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.
Inline comments:
In `@ci/markdown-link-check-config.json`:
- Around line 27-29: Update the Nimbleway URL regex in the ignore-pattern
configuration to match query-only URLs as well as existing path-based URLs,
while preserving optional www/docs subdomains and the current host matching
behavior.
In `@docs/source/conf.py`:
- Around line 88-90: Update the NimbleWay URL regex in the linkcheck ignore
configuration to match only the specific known certificate-failing URLs rather
than every current or future nimbleway.com path. Preserve link checking for the
troubleshooting link and other domain URLs, using the existing regex
configuration in conf.py.
In `@docs/source/customization/you-com.md`:
- Around line 89-90: Update the max_retries and timeout descriptions in the
customization table to match the current runtime contract: max_retries=3
represents three total attempts, and timeout=null means no timeout. Keep the
implementation unchanged and revise only the documentation wording.
In `@docs/source/resources/faq.md`:
- Line 63: Update the You.com APIs entry in the FAQ to state that YDC_API_KEY is
required for live API calls, not application startup, while preserving the
existing description of supported capabilities.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 0f390ddb-a06c-46a3-bf3e-9e6ad64a407b
📒 Files selected for processing (15)
.secrets.baselineCHANGELOG.mdREADME.mdci/markdown-link-check-config.jsondocs/README.mddocs/source/conf.pydocs/source/customization/configuration-reference.mddocs/source/customization/index.mddocs/source/customization/tools-and-sources.mddocs/source/customization/you-com.mddocs/source/index.mddocs/source/project.jsondocs/source/resources/faq.mddocs/source/resources/troubleshooting.mddocs/source/versions1.json
💤 Files with no reviewable changes (1)
- docs/source/versions1.json
📜 Review details
⏰ Context from checks skipped due to timeout. (3)
- GitHub Check: Pytest and Coverage
- GitHub Check: Lint and Hooks
- GitHub Check: Script Validation
🧰 Additional context used
📓 Path-based instructions (4)
docs/source/**/*
📄 CodeRabbit inference engine (AGENTS.md)
Update the docs under docs/source/ when behavior, configuration, or workflows change
Files:
docs/source/project.jsondocs/source/index.mddocs/source/customization/index.mddocs/source/resources/faq.mddocs/source/customization/tools-and-sources.mddocs/source/customization/you-com.mddocs/source/resources/troubleshooting.mddocs/source/customization/configuration-reference.mddocs/source/conf.py
{docs/**,README.md,CONTRIBUTING.md,SECURITY.md,CODE-OF-CONDUCT.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,SECURITY.md,CODE-OF-CONDUCT.md}: Review documentation for command accuracy, branch-name consistency, current CI and copy-pr-bot behavior, public
vs internal boundary clarity, stale examples, and links that no longer match the repository layout.
Files:
docs/source/project.jsondocs/source/index.mddocs/source/customization/index.mddocs/README.mddocs/source/resources/faq.mddocs/source/customization/tools-and-sources.mddocs/source/customization/you-com.mddocs/source/resources/troubleshooting.mddocs/source/customization/configuration-reference.mddocs/source/conf.pyREADME.md
{.github/**,ci/**,.pre-commit-config.yaml,pyproject.toml,uv.lock,mcp/pyproject.toml,mcp/uv.lock}
⚙️ CodeRabbit configuration file
{.github/**,ci/**,.pre-commit-config.yaml,pyproject.toml,uv.lock,mcp/pyproject.toml,mcp/uv.lock}: Review automation and packaging changes for least-privilege permissions, pinned versions where appropriate,
copy-pr-bot pull-request/ branch behavior, reproducible uv/npm setup, secret handling, and consistency with
the documented validation matrix.
Files:
ci/markdown-link-check-config.json
**/*.py
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run ruff check and ruff format validation for Python code changes
**/*.py: Python code must be linted and formatted with Ruff using line length 120, target Python 3.11, rule sets E,F,W,I,PL,UP, and isort force-single-line configuration
Never commit secrets, tokens, or environment-specific hostnames; use environment variables and SecretStr instead, resolving API keys at runtime
Never print or log secret values, including in tool output or error messages
Missing-secret paths must degrade gracefully (stub/skip), not crash or leak
Do not hand-reformat unrelated code when making changes; match the existing import and formatting style
Files:
docs/source/conf.py
🔇 Additional comments (15)
CHANGELOG.md (3)
5-5: LGTM!
17-22: LGTM!
40-45: LGTM!docs/source/project.json (1)
3-3: LGTM!docs/source/conf.py (2)
4-14: LGTM!Also applies to: 72-72
58-58: 🗄️ Data Integrity & IntegrationNo action needed The published switcher index already includes
2.2.0-rc1, soversion_matchaligns.docs/README.md (1)
28-40: LGTM!docs/source/customization/tools-and-sources.md (1)
7-12: LGTM!docs/source/resources/troubleshooting.md (1)
27-29: LGTM!docs/source/customization/configuration-reference.md (1)
207-208: LGTM!Also applies to: 640-640, 656-656
docs/source/index.md (1)
54-54: LGTM!README.md (1)
72-73: LGTM!Also applies to: 93-94, 216-217, 228-229, 244-248, 283-283
docs/source/customization/index.md (1)
17-20: LGTM!docs/source/resources/faq.md (1)
85-85: LGTM!.secrets.baseline (1)
136-136: LGTM!Also applies to: 358-358
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
|
/merge |
c859946
into
NVIDIA-AI-Blueprints:release/2.2
3 participants
Overview
Fix the AI-Q 2.2 documentation publication contract and refresh release-facing documentation against the current
release/2.2branch.The version selector had three independent sources of drift:
conf.pystill renderedversion_match = 1.2.1after the site was deployed under2.2.0-rc1.project.jsonand the Sphinx release value had to be updated separately.../versions1.jsonresolved to the publisher-managed root index on top-level pages but to the copied per-version file on nested pages. That copied file contained only one version and used the invalidai-blueprintsite slug.This change makes
docs/source/project.jsonthe single version authority, sets it to the exactv2.2.0-rc1artifact version, points every page at the canonical publisher-managed selector index, and removes the duplicated per-buildversions1.json.The release-facing README, changelog, FAQ, troubleshooting, and navigation now cover Azure AI Search, You.com, Nimble, the standalone public MCP server, the workflow-configuration maintainer skill, and all eleven checked-in workflow profiles. The Nimble links use its canonical documentation, with narrowly scoped exclusions in both link checkers because Nimble's certificate chain is not accepted by Python/OpenSSL or the Node link checker.
Developer impact: advancing the docs version now requires one edit to
project.json; Sphinx and the NVIDIA Docs publisher consume the same value.DCO sign-off for the squash commit
Signed-off-by: Ajay Thorve AjayThorve@users.noreply.github.com
Validation
The live publisher index at
https://docs.nvidia.com/aiq-blueprint/versions1.jsoncurrently reports2.2.0-rc1,2.1.0,2.0.0, and1.2.1. Generated top-level and nested pages both use that canonical index and match2.2.0-rc1.git commit -sor an equivalent sign-off.Where should reviewers start?
Start with
docs/source/conf.py,docs/source/project.json, and the removal ofdocs/source/versions1.json; together they define the publication and selector invariant. Then review the config inventory inREADME.mdanddocs/source/customization/configuration-reference.md, followed bydocs/source/customization/you-com.mdand the Nimble link-check handling.Related Issues
Summary by CodeRabbit
New Features
Documentation
Chores