Skip to content

Add versioning section to installation docs#2006

Merged
shi-eric merged 1 commit into
newton-physics:mainfrom
shi-eric:ershi/versioning-docs
Mar 9, 2026
Merged

Add versioning section to installation docs#2006
shi-eric merged 1 commit into
newton-physics:mainfrom
shi-eric:ershi/versioning-docs

Conversation

@shi-eric

@shi-eric shi-eric commented Mar 9, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

Add a "Versioning" section to the installation guide explaining Newton's major.minor.micro versioning scheme, adapted from Warp's versioning docs. Covers stable release numbering and prerelease version formats (development builds and release candidates).

Checklist

  • New or existing tests cover these changes
  • The documentation is up to date with these changes
  • CHANGELOG.md has been updated (if user-facing change)

Test plan

  • Verify the Sphinx docs build without warnings: 
    uv run --extra docs --extra sim sphinx-build -j auto -W -b html docs docs/_build/html
  • Check that the "Versioning" section renders correctly on the installation page before "Next Steps"

Summary by CodeRabbit

  • Documentation
    • Added a new Versioning section to the installation guide detailing the major.minor.micro version scheme, prerelease formats (development builds and release candidates), and stability information.

@coderabbitai

coderabbitai Bot commented Mar 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 95b63853-eacc-40f7-9a23-572bf6dcbabd

📥 Commits

Reviewing files that changed from the base of the PR and between f52342b and 1a0072f.

📒 Files selected for processing (1)
  • docs/guide/installation.rst
📝 Walkthrough

Walkthrough

A new Versioning section was added to the installation documentation describing Newton's version numbering scheme (major.minor.micro), prerelease formats (development builds and release candidates), and stability notes. The same content appears in two separate locations within the document.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/guide/installation.rst		 Added Versioning section explaining version scheme and prerelease formats; content is duplicated in two locations within the document.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

docs

Suggested reviewers

  • adenzler-nvidia
🚥 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 accurately describes the main change: adding a versioning section to the installation documentation.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@shi-eric shi-eric self-assigned this Mar 9, 2026
@shi-eric shi-eric added the docs Improvements or additions to documentation label Mar 9, 2026
@codecov

codecov Bot commented Mar 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

preist-nvidia
preist-nvidia approved these changes Mar 9, 2026
View reviewed changes

@preist-nvidia preist-nvidia 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.

Thank you Eric - looks good to me.

@shi-eric shi-eric added this pull request to the merge queue Mar 9, 2026
Merged via the queue into newton-physics:main with commit d6da819 Mar 9, 2026
22 checks passed
adenzler-nvidia pushed a commit to adenzler-nvidia/newton that referenced this pull request Mar 9, 2026
@shi-eric @adenzler-nvidia
Add versioning section to installation docs (newton-physics#2006)
480d83d
@adenzler-nvidia adenzler-nvidia mentioned this pull request Mar 9, 2026
Merged
@shi-eric shi-eric deleted the ershi/versioning-docs branch March 20, 2026 04:05
@coderabbitai coderabbitai Bot mentioned this pull request Mar 25, 2026
Merged
3 tasks
mmacklin pushed a commit to mmacklin/newton that referenced this pull request Apr 7, 2026
@shi-eric
Add versioning section to installation docs (newton-physics#2006)
8a296b8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@preist-nvidia preist-nvidia preist-nvidia approved these changes

@adenzler-nvidia adenzler-nvidia Awaiting requested review from adenzler-nvidia

Assignees

@shi-eric shi-eric

Labels

docs Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shi-eric @preist-nvidia @adenzler-nvidia