Skip to content

Add release notes and an upgrade guide to the docs - #157

Merged
Noah-Tervalon-Nvidia merged 3 commits into
developfrom
docs/release-notes-and-upgrade-guide
Oct 9, 2026
Merged

Noah-Tervalon-Nvidia merged 3 commits into
developfrom
docs/release-notes-and-upgrade-guide

Conversation

@ckelseynv

@ckelseynv ckelseynv commented Oct 9, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Adds two pages to the public docs: Release Notes, starting with 1.0.0, and an Upgrade Guide for updating from a version before 1.0.0. People who read the docs rather than GitHub had no release notes to look at.

The 1.0.0 notes are adapted from the release notes master doc. The Upgrade Guide starts from the fact that most machines need nothing extra, then covers the few setups that need a small step:

  • tidying up the old PAIR.app on macOS;
  • an LM Studio that an earlier PAIR installed;
  • browser clients affected by the CORS change.

Changelog title

n/a

Changelog body

n/a

Bumps

  • services: none
  • nvpair-cluster-manager: none
  • nvpair-engine-manager: none
  • nvpair-errors: none
  • nvpair-job-scheduler: none
  • nvpair-manual-nodes: none
  • nvpair-node-info: none
  • nvpair-node-scanner: none
  • nvpair-node-settings: none
  • nvpair-proxy: none
  • nvpair-tui: none
  • nvpair-ui-broker: none
  • nvpair-workload-manager: none

Scope

  • docs/release-notes.mdx (new): the 1.0.0 notes, covering what's new, compatibility notes, targeted bug fixes, community contributions with PR links, and special thanks. Notes before 1.0.0 are linked on GitHub Releases.
  • docs/upgrade-guide.mdx (new). It opens by saying an update keeps settings, cluster membership, and models, and that every machine in a cluster should run the same version. Each section then says who it applies to:
    • On macOS, tidy up the old app: run the old app's uninstall-macos.sh without --purge, then install NVIDIA PAIR.app. 0.1.0 and 0.1.1 both ship that script, and both keep data without --purge.
    • If an earlier PAIR installed LM Studio for you: it keeps working, but it has no install marker (installed-by-pair.json), so Uninstall, Reset app data, and uninstalling PAIR leave it. Steps to remove it while keeping models, or to reinstall it so PAIR manages it.
    • If you use PAIR from a web page or browser extension: which launch option allows a site for each engine.
    • Checking everything is working.
  • fern/docs.yml: both pages under Guides, after Getting Started.
  • README.md, docs/getting-started.mdx ("Keeping PAIR Up to Date" and "Learn More"), and docs/known-issues.mdx: link to the new pages. known-issues gains an entry for the LM Studio limitation.

Validation

Risk

Documentation only. No code, build, or versioned file changes.

Left for the product owner to confirm against the master doc:

  • The app is named NVIDIA PAIR (NVIDIA PAIR.app).
  • The macOS note does not say models could be lost, because models never live inside the app.
  • The bug-fix line names LM Studio only, because llama.cpp never shipped publicly.
  • README.md and known-issues.mdx still call Windows on ARM experimental, beside the RTX Spark validation note.

Checklist

  • I have read the Contributing Guidelines.
  • Every commit is signed off (git commit -s), certifying the Developer Certificate of Origin.
  • New or existing tests cover the change. (Documentation only.)
  • Relevant documentation is updated.
  • I checked the diff, changed filenames, and commit messages for credentials, private data, internal URLs, internal issue identifiers, and generated artifacts.
  • I recorded the validation commands and results above.
  • I declared version bumps in the release-intent block above. services/versions.json is written by automation — do not edit it by hand.

Add a Release Notes page, starting with 1.0.0, and an Upgrade Guide for
updating from an earlier version. The guide notes that most machines need
nothing extra, then covers tidying up the old PAIR.app on macOS, an
LM Studio installed by an earlier PAIR that has no install marker, and
browser clients affected by the CORS change. Link both from the docs
navigation, the README, Getting Started, and Known Issues.

Signed-off-by: Chris Kelsey <ckelsey@nvidia.com>
@ckelseynv
ckelseynv force-pushed the docs/release-notes-and-upgrade-guide branch from 32aa4bd to faba174 Compare October 9, 2026 16:19
@ckelseynv
ckelseynv changed the base branch from docs/release-stack-docs-pass to develop October 9, 2026 16:19
Comment thread docs/known-issues.mdx Outdated
Comment thread docs/release-notes.mdx Outdated
Comment thread docs/upgrade-guide.mdx
…ue, explain PAIR.app after in-place update

Signed-off-by: Chris Kelsey <ckelsey@nvidia.com>
Signed-off-by: Chris Kelsey <ckelsey@nvidia.com>
@Noah-Tervalon-Nvidia
Noah-Tervalon-Nvidia merged commit bf97597 into develop Oct 9, 2026
7 checks passed
@Noah-Tervalon-Nvidia Noah-Tervalon-Nvidia mentioned this pull request Oct 9, 2026
6 of 7 tasks
Noah-Tervalon-Nvidia added a commit that referenced this pull request Oct 9, 2026
## Description

Cuts release 1.0.0. The release-intent bot only bumps the patch version,
so the major bump is made by hand: `desktop/package.json` and both root
entries in `desktop/package-lock.json` move from 0.1.15 to 1.0.0.
`CHANGELOG.md` gets a 1.0.0 section that points to the release notes
added in #157.

Every bump below is `none`, so the bot leaves the version files alone
when this merges. The marker below permits the hand edit to
`CHANGELOG.md`, which is otherwise bot-owned.

<!-- pair-release-intent-allow-owned-files -->

## Release intent

<!-- pair-release-intent:v1 -->
### Changelog title
n/a

### Changelog body
n/a

### Bumps
- services: none
- nvpair-cluster-manager: none
- nvpair-engine-manager: none
- nvpair-errors: none
- nvpair-job-scheduler: none
- nvpair-manual-nodes: none
- nvpair-node-info: none
- nvpair-node-scanner: none
- nvpair-node-settings: none
- nvpair-proxy: none
- nvpair-tui: none
- nvpair-ui-broker: none
- nvpair-workload-manager: none
<!-- /pair-release-intent:v1 -->

## Scope

In scope: the release version and a changelog pointer. Out of scope:
`services/versions.json` and the component versions, which are versioned
independently and do not change, and the release notes themselves.

## Validation

- `python3 scripts/release-intent/test_lib.py`: 33 tests OK.
- `scripts/release-intent/validate_pr.py` against this body:
release-intent OK, all bumps none.
- Bot-owned path check on this diff: passes with the marker, rejects
`CHANGELOG.md` without it.
- `scripts/release-intent/apply_pr.py --dry-run` against this body: no
version files to update.
- `package.json` and both root `package-lock.json` entries read 1.0.0.

## Risk

This must be the last merge with a non-`none` bump before the `develop`
→ `main` cut. The bot patch-bumps from whatever `package.json` says, so
a later release bump would ship 1.0.1.

## Checklist

- [x] I have read the [Contributing
Guidelines](https://github.com/NVIDIA/Personal-AI-Router/blob/main/CONTRIBUTING.md).
- [x] Every commit is signed off (`git commit -s`), certifying the
[Developer Certificate of Origin](https://developercertificate.org/).
- [ ] New or existing tests cover the change.
- [x] Relevant documentation is updated.
- [x] I checked the diff, changed filenames, and commit messages for
credentials, private data, internal URLs, internal issue identifiers,
and generated artifacts.
- [x] I recorded the validation commands and results above.
- [x] I declared version bumps in the release-intent block above.
`services/versions.json` is written by automation — do not edit it by
hand.

Signed-off-by: Terve <ntervalon@nvidia.com>
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.

2 participants