Skip to content

Compatibility Posture

Reference for the Nimi public docs' compatibility and migration posture.

Posture Summary

PropertyValue
Posture nameno_legacy_hard_cut
Pre-launchyes
Soft compatibility shimsforbidden
Time-phased layeringforbidden (layering is ontological: core / extended / custom)
Strict-only protocol versioningyes
Fail-close on contract violationyes
Retry rescues contract failureno

Practical Implications For Readers

SituationExpected behavior
A page is removedPreferred over a stale page
A typed contract failsSurfaces a typed error, not a silent fallback
A retry happensOnly for transport / auth refresh, never to rescue a contract
An older route existsEither kept as admitted public truth or hard-removed; not preserved as hidden compatibility
A new feature shipsLands with full contract design, not as a temporary subset to be filled in later

Forbidden Compatibility Shapes

Repository authority rejects three broad shapes: retaining superseded product semantics after a hard cut, creating an unadmitted parallel truth, and returning pseudo-success when an admitted contract cannot be fulfilled. Individual owner-domain contracts add narrower prohibitions where required; there is no separate Nimi Coding anti-pattern catalog.

Public Claim Constraints

Claim typePosture
Install commands (curl / npm / pnpm / brew / apt / yarn)Withheld until admitted distribution evidence under the matching release contract
Download linksWithheld until admitted distribution evidence under the matching release contract
Release status / launch promisesWithheld until admitted release evidence
Concrete provider name / model nameWithheld until admitted catalog evidence under the runtime model-catalog contract
Provider availability matrixWithheld until admitted catalog evidence under the runtime model-catalog contract
"Available now" / "GA" / "Stable" claims for defined-but-not-shipped surfacesForbidden

The complete list of forbidden public docs claims with detection patterns is in Forbidden Claims.

Contract Evolution Path

How a defined-but-not-shipped surface graduates to a public surface:

  1. Kernel contract is admitted under the appropriate authority domain (P-PROTO-* / K-* / S-* / D-* / R-*).
  2. Implementation lands under the owner domain.
  3. Catalog evidence (for providers / models) is admitted.
  4. Distribution / release evidence is admitted (for install / download).
  5. Public docs page is updated to reflect availability.

A docs page cannot pre-announce a stage that the contract evolution has not reached.

Source Basis

Documentation for Nimi — the installable, open-source, local-first personal AI product.