From 6ce027b575e76c0c62b01fd4cd4b4ae2dfd0c58c Mon Sep 17 00:00:00 2001 From: Noah Schatz Date: Wed, 7 Oct 2026 23:55:32 +0000 Subject: [PATCH] Bring the docs status blocks current for 0.1 docs-content/intro.md, installation.md, troubleshooting.md and the matching bullet in KNOWN-LIMITATIONS.md said the package was "still pre-alpha on the 0.0.x-until-first-alpha ladder". It is on npm at 0.1.1 (npm view @cosyte/x12 version), and npm install @cosyte/x12 installs in a fresh directory. Each now states 0.1 and the policy the README states: the exported readers, builders, types and warning codes are the surface we keep stable, and below 1.0 a breaking change bumps the minor version and is called out in the changelog with its migration. Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9 --- KNOWN-LIMITATIONS.md | 8 ++++---- docs-content/installation.md | 7 +++---- docs-content/intro.md | 7 ++++--- docs-content/troubleshooting.md | 8 ++++---- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/KNOWN-LIMITATIONS.md b/KNOWN-LIMITATIONS.md index 11d9253..ca1c07d 100644 --- a/KNOWN-LIMITATIONS.md +++ b/KNOWN-LIMITATIONS.md @@ -1874,10 +1874,10 @@ N-char spec limit` refusal, one per emitting module, where the branch fires **be applied and this package applies none. - **No transport.** AS2, SFTP, and MLLP-style delivery are out of scope. This is a parser/serializer, not a communications stack. -- **Published, still pre-alpha.** The package is published on npm as `@cosyte/x12` from a public - repo, but it stays on the `0.0.x`-until-first-alpha ladder. `npm view @cosyte/x12 version` is the - only source of truth for the current version, so this page does not restate one. Treat the API as - pre-alpha and pin the exact version until the first alpha. +- **Below 1.0.** The package is published on npm as `@cosyte/x12` from a public repo, at `0.1`. Its + exported readers, builders, types and warning codes are the surface we keep stable, and below 1.0 + a breaking change bumps the minor version and is called out in the changelog with its migration. + `npm view @cosyte/x12 version` is the only source of truth for the current version. - **A 276 hierarchical level whose declared parent does not resolve is left off the returned tree.** The 276 reader attaches a level by its own HL-02 and by nothing else, so a pointer naming a level that is not present, a pointer naming a level of the wrong kind, and a parent chain that returns diff --git a/docs-content/installation.md b/docs-content/installation.md index 8e0743c..9bcb09d 100644 --- a/docs-content/installation.md +++ b/docs-content/installation.md @@ -10,10 +10,9 @@ sidebar_position: 2 per-condition type declarations, so it works from either module system without configuration, and it has **zero runtime dependencies**: Node stdlib only. -> **Status:** published on npm and public, still pre-alpha on the -> `0.0.x`-until-first-alpha ladder. The `npm install` below is live; pin the exact version and treat -> the API as pre-alpha until the first alpha. Run `npm view @cosyte/x12 version` for the version to -> pin: it is the source of truth, and this page deliberately does not restate one. +> **Status:** `0.1`, published on npm and public. The `npm install` below is live. Below 1.0 a +> breaking change bumps the minor version and is called out in the changelog with its migration. +> Run `npm view @cosyte/x12 version` for the current version: it is the source of truth. ## Prerequisites diff --git a/docs-content/intro.md b/docs-content/intro.md index d96f65f..19c8307 100644 --- a/docs-content/intro.md +++ b/docs-content/intro.md @@ -11,9 +11,10 @@ healthcare interchange and read fields out of it without first reading the X12 s implementation guide. `@cosyte/x12` is the payer-side sibling of [`@cosyte/hl7`](https://github.com/cosyte/hl7): the API shape, profile system, and lenient-parser philosophy are deliberately mirrored. -> **Status:** published on npm and public, still pre-alpha on the `0.0.x`-until-first-alpha -> ladder. `npm view @cosyte/x12 version` is the source of truth for the current version; this page -> does not restate it. The **shipped** surface is the HIPAA 005010 read side for 270, 271, 276, +> **Status:** `0.1`, published on npm and public. The exported readers, builders, types and warning +> codes are the surface we keep stable, and below 1.0 a breaking change bumps the minor version and +> is called out in the changelog with its migration. `npm view @cosyte/x12 version` is the source of +> truth for the current version. The **shipped** surface is the HIPAA 005010 read side for 270, 271, 276, > 277/277CA, 278, 820, 834, 835, 837P/I/D, 999, and TA1, the emit > side (`serializeX12` + `buildInterchange` and a domain builder for each of those sets), > and the descriptive trading-partner profile system. This documentation is gated to that surface: diff --git a/docs-content/troubleshooting.md b/docs-content/troubleshooting.md index 77f6cea..621eed4 100644 --- a/docs-content/troubleshooting.md +++ b/docs-content/troubleshooting.md @@ -372,10 +372,10 @@ third party. (`X12_PRE_005010`), not decoded to older field maps. - **No transport.** AS2, SFTP, and MLLP-style delivery are out of scope. This is a parser/serializer, not a communications stack. -- **Published, still pre-alpha.** The package is published on npm as `@cosyte/x12` from a public - repo, but it stays on the `0.0.x`-until-first-alpha ladder. `npm view @cosyte/x12 version` is the - only source of truth for the current version, so this page does not restate one. Treat the API as - pre-alpha and pin the exact version until the first alpha. +- **Below 1.0.** The package is published on npm as `@cosyte/x12` from a public repo, at `0.1`. Its + exported readers, builders, types and warning codes are the surface we keep stable, and below 1.0 + a breaking change bumps the minor version and is called out in the changelog with its migration. + `npm view @cosyte/x12 version` is the only source of truth for the current version. - **A 276 hierarchical level whose declared parent does not resolve is left off the returned tree.** The 276 reader attaches a level by its own HL-02 and by nothing else, so a dangling pointer, a pointer naming a level of the wrong kind, and a parent chain that returns to itself each leave that