Repository navigation
Open the docs Quickstart with the README's program - #68
Merged
Merged
Conversation
docs.cosyte.com renders this package's Quickstart page from docs-content/quickstart.md, which opened with the seeded value providers while the README's quickstart opens with the HL7 v2 generators. 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 quickstart block verbatim, tagged runnable so the docs build executes it, with a line saying what it prints. The value-provider, round-trip, corpus and determinism examples follow; the old "Generate an HL7 v2 message" section becomes "Check the round trip yourself", keeping its asserted zero-warning claim. test/docs-content.test.ts gains one case: the page's first runnable block must equal the README's first TypeScript block after ## Install, byte for byte (a changed seed in the page reds it; checked). A patch changeset records the change. Sidebar untouched. 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
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
createRng,safeandisSyntheticSsn, while the README's quickstart opens with the@cosyte/synth/hl7generators. Two first-use routes, two different first programs.What changes
docs-content/quickstart.md: a new first section, "Generate a spec-clean HL7 v2 message", carrying the README's quickstart block verbatim (taggedts runnable, so the docs build executes it), with a line saying what it prints and a link to Installation for the@cosyte/hl7peer. The value-provider, corpus and determinism sections follow; "Generate an HL7 v2 message" becomes "Check the round trip yourself" and keeps its assertedresult.warnings; // => []. Sidebar untouched (Installation and Quickstart stay top-level categories); no.gitURLs.test/docs-content.test.ts: one new case, the page's first runnable block must equal the README's first TypeScript block after## Install, byte for byte. Negative control: changing the seed in the page's block reds it.Checks run locally (pnpm 10.0.0, Node 24)
typecheck,lint,format:check,test(56 files, 828 tests),check(test-selection),phi-scan(all-mode and--staged),check:no-emdash,check:no-internal-refs: all exit 0. The shared release-notes renderer keeps the changeset's headline with no violation.https://claude.ai/code/session_01U24bnHKNxQWMxmfN7ny7w9