Skip to content

Bring the API stability section current for 0.1 #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NSchatz merged 1 commit into from
Oct 8, 2026
Merged

Bring the API stability section current for 0.1 #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-content/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ inspects the payload.
> **Status:** published on npm and public, so the `npm install @cosyte/mllp` command below is live,
> not aspirational. Where the package sits on the release ladder, and what that means for the
> stability of its public surface, is stated in one place:
> [The API is not stable yet](./limitations.md#the-api-is-not-stable-yet). Read it before you pin.
> [API stability](./limitations.md#api-stability). Read it before you pin.

## Prerequisites

Expand Down
11 changes: 6 additions & 5 deletions docs-content/limitations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,12 +219,13 @@ accumulated bytes (`MLLP_TRAILING_BYTES`) and delivers only the fragment after i
path downgrades that frame rather than positively acknowledge a destroyed message. Batch ACK is its
own unbuilt feature.

## The API is not stable yet
## API stability

`@cosyte/mllp` is on the `0.0.x` ladder and **pre-alpha**. There is no API-stability promise and no
deprecation cycle: any release may change the public surface. The stable **warning codes** and
**security-warning codes** are treated as public API within that caveat (renaming one is a breaking
change) but the ladder itself makes no 1.0-style guarantees. Pin an exact version.
`@cosyte/mllp` is at `0.1`: it has left the pre-alpha `0.0.x` ladder. The client, the server, the
framing codec, the in-memory transport and the optional `ack-from-hl7` bridge are the surface we
keep stable. The stable **warning codes** and **security-warning codes** are part of that surface,
so renaming or removing one is a breaking change. Below 1.0 a breaking change moves the minor
version, and the changelog says how to migrate.

---

Expand Down
Loading