Repository navigation
Open the docs Quickstart with the README's program - #87
Merged
Merged
Conversation
docs.cosyte.com renders this package's Quickstart page from docs-content/quickstart.md, which opened with framing bytes by hand while the README's quickstart starts a server and a client. A reader arriving from npm and one arriving from the documentation site met two different first programs. The page now leads with the README's first Usage example and the output printed beside it, tagged runnable so the docs build executes it; the framing, tolerance and encoder examples follow unchanged, and the note on runnable examples says why the first one can run (a loopback port the operating system picks, both ends closed). test/docs-content.test.ts holds the new first example the way it held the old one: it must equal the README's block and output, compile against the package's types (with a control that reds on a mutation), print exactly the output shown when run against the built package, change that output when its control id changes, and put a fixture's bytes on the wire. The framing example keeps a claim-mutation control and is now held to its own fixture. A patch changeset and the readiness row record the change. Claude-Session: https://claude.ai/code/session_01U24bnHKNxQWMxmfN7ny7w9
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.
The docs Quickstart page (
docs-content/quickstart.md, which docs.cosyte.com renders) now opens with the same program as the README quickstart. Docs and test change only; nosrc/change.Why
The page opened with
encodeFrameandFrameReaderby hand, while the README's quickstart starts a server and a client on loopback, sends one message and reads its acknowledgement. Two first-use routes, two different first programs.What changes
docs-content/quickstart.md: a new first section, "Send a message and read the acknowledgement", carrying the README's first Usage block verbatim (taggedts runnable) and itstextoutput block. The framing, tolerance and encoder sections follow unchanged, then the existing client and server illustrations. The front-matter description, the intro and the note on runnable examples say what changed. Sidebar untouched (Installation and Quickstart stay top-level categories); no.gitURLs.test/docs-content.test.ts: the first-example checks now target the new block. It must equal the README's first Usage block and output, compile against the package's types (the control mutatesmsa?.[1]tomsa[1]and expects TS18048), print exactly the shown output when run against the built package, print something else whenCTRL0001becomesCTRL0002, and put a first-use fixture's bytes on the wire. The claim-mutation control moves to the framing example (now second), which is also held to its own fixture (quickstart-adt-a01.hl7).documentation/release-0.1.0-readiness.md.Checks run locally (pnpm 10.0.0, Node 24)
typecheck,lint,format:check,test(86 files, 1497 tests),phi-scan(all-mode and--staged),check:no-emdash,check:no-internal-refs,check:agent-notes: all exit 0. The shared release-notes renderer keeps the new changeset's headline with no violation.https://claude.ai/code/session_01U24bnHKNxQWMxmfN7ny7w9