Skip to content

docs: organise the docs for v0.8.0 and write its release notes - #80

Merged
MrScripty merged 3 commits into
mainfrom
docs/v080-cleanup
Nov 4, 2026
Merged

MrScripty merged 3 commits into
mainfrom
docs/v080-cleanup

Conversation

@MrScripty

Copy link
Copy Markdown
Owner

Cleans up the docs before tagging v0.8.0 and rewrites the release notes that become the GitHub release body.

Release notes: docs/release-notes-0.8.0.md is rewritten as user-facing notes: highlights, desktop changes (categories by use, Decision and Video, modality and adapter badges, "Used as"), the typed consumer API and new capabilities, Rust API changes, the library upgrade, which of the sixteen downloads to pick, and known limitations. CHANGELOG.md dates 0.8.0 and 0.7.0.

Removed (180 files, all recoverable from 78c52fcf): completed or superseded plans, point-in-time audits and investigations, 0.7.0 release evidence and QA, the untagged rc.1 notes, the stale 0.8.0 QA checkpoint, and two scripts for the removed Python backend. Files that release tooling reads are kept (managed-Python license inputs, release attribution, and the 0.7.0 ONNX archive verification that the hashed attribution README cites).

Durable knowledge moved to current owners: ADR 0004 (model category as metadata), a Hugging Face model-detail cache contract, Torch version rules, the Nomic fixture identity, accepted advisory exceptions, RPC call diagnostics.

Corrected guides against code and CI: README, CONTRIBUTING, RELEASING, ARCHITECTURE, DEVELOPMENT, SECURITY, native bindings, subsystem READMEs, contracts, ADR 0003 and briefs. The docs index now lists contracts, ADRs, runbooks, briefs and the plans that still hold open gates.

Checks run locally: relative link check (0 broken), release attribution (default and s3), release version alignment, dependency ownership, scripts/release Node tests (37/37) and Python tests (8/8).

🤖 Generated with Claude Code

Release notes and changelog:
- Rewrite docs/release-notes-0.8.0.md as user-facing notes: highlights,
  desktop changes, the typed consumer API, Rust API changes, the library
  upgrade, the sixteen downloads, and known limitations.
- Date 0.8.0 and 0.7.0 in CHANGELOG.md and add the Rust API changes.

Removed (all recoverable from 78c52fc):
- Completed or superseded plans: local intent API, the v080 consumer API,
  model categories, packaging, qualification and readiness plans, three
  Torch plans, eleven finished HF/acquisition plan files, and dated reports
  and command-log archives under the remaining plans.
- Point-in-time audits, investigation logs, 0.7.0 release evidence and QA,
  the untagged 0.8.0-rc.1 notes, the stale 0.8.0 QA checkpoint and the 0.7.0
  dependency reviews.
- Two scripts that compared against the removed Python backend.

Kept durable knowledge in current owners:
- ADR 0004 for model categories as metadata; a Hugging Face model-detail
  cache contract; Torch version rules in torch-server/README.md; the Nomic
  fixture identity in RELEASING.md; accepted advisory exceptions in
  SECURITY.md; RPC call diagnostics in the pumas-rpc README.

Corrected stale guides against the code and CI: README, CONTRIBUTING,
RELEASING, ARCHITECTURE, DEVELOPMENT, SECURITY, native bindings, the
subsystem READMEs, contracts, ADR 0003 and the briefs. The docs index lists
contracts, ADRs, runbooks, briefs and the plans that still hold open gates.
No relative link is broken.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: bbc2aa75-8818-4919-9f4e-f96335e22a73
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@greptile-apps

greptile-apps Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 4/5

[Low impact] The PR changes documentation and removes historical working-tree material, not runtime code.

The PR appears safe to merge, with two non-blocking documentation corrections.

Findings

  1. P2 Torch lock scope is overstated ▶
  2. P2 Windows file protection is overstated ▶

Summary

This PR reorganizes the documentation for 0.8.0, rewrites its release notes, and removes historical plans and reports.

  • The 0.8.0 release notes guide users through the release and its limits.
  • Current guides explain model categories and Hugging Face detail caching.
  • The documentation index and guides point readers to current contracts, procedures, and release facts.
  • The working tree no longer includes completed or superseded qualification records and legacy backend comparison scripts.

Reviews (1) · Last reviewed commit: "docs: organise the docs for v0.8.0 and w..." · Reviewed by Greptile

Comment thread docs/SECURITY.md Resolved
Comment thread docs/contracts/hf-model-detail-cache.md Resolved
MrScripty and others added 2 commits November 4, 2026 10:56
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Only the bundled preset installs from torch-server/runtime/requirements.lock.
Other managed Torch installs resolve their own dependencies, so point
auditors at each installation's runtime/requirements.txt, resolution.json
and pip-resolution.json.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MrScripty
MrScripty merged commit 9a3ec5a into main Nov 4, 2026
8 checks passed
@MrScripty
MrScripty deleted the docs/v080-cleanup branch November 4, 2026 18:01
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.

1 participant