Skip to content

docs: align adapter contract package readmes - #246

Merged
rapids-bot[bot] merged 2 commits into
NVIDIA:release/0.2from
AjayThorve:docs/align-adapter-contract-readme
Aug 18, 2026
Merged

docs: align adapter contract package readmes#246
rapids-bot[bot] merged 2 commits into
NVIDIA:release/0.2from
AjayThorve:docs/align-adapter-contract-readme

Conversation

@AjayThorve

@AjayThorve AjayThorve commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Overview

Align the adapter-contract package README titles and add the missing repository-facing README for the Python package.

Details

  • add adapter-contract/python/README.md with package content from pypi.md, excluding PyPI-only badges and the hero image;
  • use the shared NVIDIA NeMo Fabric Adapter Contract title in the TypeScript package README.

This is documentation-only and does not change package metadata or runtime behavior.

Validation

  • /Users/athorve/Dev/mdemoret-team/nemo-fabric/.venv/bin/pre-commit run --files adapter-contract/python/README.md adapter-contract/typescript/README.md
  • sed 8,13d adapter-contract/python/pypi.md | cmp - adapter-contract/python/README.md
  • git diff --check

just docs was not run because no Fern docs or generated API references changed.

Where should the reviewer start?

Start with adapter-contract/python/README.md, then confirm the shared title in adapter-contract/typescript/README.md.

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

  • Relates to: none

  • 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.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Python package documentation covering contract usage, validation, serialization, configuration, installation, and interoperability.
    • Simplified the TypeScript package README title for consistency.

Signed-off-by: Ajay Thorve <athorve@nvidia.com>
@AjayThorve
AjayThorve requested a review from a team as a code owner August 18, 2026 00:09
@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 32d0552f-e394-480d-8f6b-53edde81a60f

📥 Commits

Reviewing files that changed from the base of the PR and between 2b0332e and 4f990b2.

📒 Files selected for processing (1)
  • adapter-contract/python/README.md
💤 Files with no reviewable changes (1)
  • adapter-contract/python/README.md

Included review availability: Your plan includes up to 12 reviews per rolling hour; 11 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (23)
  • GitHub Check: Detect docs changes
  • GitHub Check: request / require-nvskills-ci / require-nvskills-ci
  • GitHub Check: Pre-commit
  • GitHub Check: Test (arm64)
  • GitHub Check: Test (x86_64)
  • GitHub Check: Test (Python 3.14, windows-amd64)
  • GitHub Check: Test (Python 3.13, linux-amd64)
  • GitHub Check: Test (Node 24)
  • GitHub Check: Test (Python 3.11, linux-arm64)
  • GitHub Check: Test (Python 3.12, windows-amd64)
  • GitHub Check: Test (Python 3.14, linux-arm64)
  • GitHub Check: Test (Python 3.13, linux-arm64)
  • GitHub Check: Test (Python 3.12, macos-arm64)
  • GitHub Check: Test (Node 20.18.3)
  • GitHub Check: Test (Python 3.14, linux-amd64)
  • GitHub Check: Test (Python 3.14, macos-arm64)
  • GitHub Check: Test (Python 3.11, windows-amd64)
  • GitHub Check: Test (Python 3.11, linux-amd64)
  • GitHub Check: Test (Python 3.13, macos-arm64)
  • GitHub Check: Test (Python 3.11, macos-arm64)
  • GitHub Check: Test (Python 3.13, windows-amd64)
  • GitHub Check: Test (Python 3.12, linux-arm64)
  • GitHub Check: Test (Python 3.12, linux-amd64)

Walkthrough

The PR adds Python adapter contract package documentation and shortens the TypeScript adapter contract README title.

Changes

Adapter contract documentation

Layer / File(s) Summary
Document adapter contract packages
adapter-contract/python/README.md, adapter-contract/typescript/README.md
The Python README documents package scope, validation, serialization, Pydantic interoperability, configuration, installation, and references. The TypeScript README title is shortened.

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

Merge Risk: ⚪ Minimal · up to 4f990

This documentation-only change adds the Python package README and aligns the TypeScript README title without affecting package behavior; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title uses the allowed docs type, an imperative summary, and remains under 72 characters without a trailing period.
Description check ✅ Passed The description includes the required overview, reviewer starting point, related-issues section, validation details, and contributor checkboxes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment thread adapter-contract/python/README.md Outdated

@zhongxuanwang-nv zhongxuanwang-nv left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks Ajay!

Comment thread adapter-contract/python/README.md Outdated
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
@AjayThorve

Copy link
Copy Markdown
Collaborator Author

/merge

@rapids-bot
rapids-bot Bot merged commit 9d2deaa into NVIDIA:release/0.2 Aug 18, 2026
33 checks passed
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.

3 participants