docs: align adapter contract package readmes - #246
Conversation
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
|
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 (1)
💤 Files with no reviewable changes (1)
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)
WalkthroughThe PR adds Python adapter contract package documentation and shortens the TypeScript adapter contract README title. ChangesAdapter contract documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to 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)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
|
/merge |
Overview
Align the adapter-contract package README titles and add the missing repository-facing README for the Python package.
Details
adapter-contract/python/README.mdwith package content frompypi.md, excluding PyPI-only badges and the hero image;NVIDIA NeMo Fabric Adapter Contracttitle 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.mdsed 8,13d adapter-contract/python/pypi.md | cmp - adapter-contract/python/README.mdgit diff --checkjust docswas 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 inadapter-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