Repository navigation
Bring the API stability section current for 0.1 - #93
Merged
Merged
Conversation
docs-content/limitations.md, under "The API is not stable yet", said the package was pre-alpha on the 0.0.x ladder with no API-stability promise. It is on npm at 0.1.0. The section is now "API stability" and states what the README states: 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 warning and security-warning codes are part of it, and below 1.0 a breaking change moves the minor version with the changelog saying how to migrate. The link from installation.md follows the new heading, and the section remains the one page carrying the release-status claim that test/docs/structure.test.ts looks for. Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bring the API stability section current for 0.1
docs-content/limitations.md, under "The API is not stable yet", said the
package was pre-alpha on the 0.0.x ladder with no API-stability promise.
It is on npm at 0.1.0. The section is now "API stability" and states what
the README states: 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 warning and security-warning codes are part of it, and
below 1.0 a breaking change moves the minor version with the changelog
saying how to migrate. The link from installation.md follows the new
heading, and the section remains the one page carrying the release-status
claim that test/docs/structure.test.ts looks for.
https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9