Skip to content

docs: lead with the lockup, link the integration services page, and write to the house style - #16

Merged
NSchatz merged 2 commits into
mainfrom
docs/readme-standards
Nov 7, 2026
Merged

NSchatz merged 2 commits into
mainfrom
docs/readme-standards

Conversation

@NSchatz

@NSchatz NSchatz commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

The operator approved merging the standards pull requests on green on 2026-11-07 ("Approved. Merge.", in session cosyte-71).

Reader-visible text in a public repo: the README, the ten starter READMEs, and a new AGENTS.md. Nothing here deploys or publishes.

What changes

  • Lockup (BR4, ST20). README.md opens with the shared lockup tile pair in a picture element, in hl7's README shape: the on-dark tile for a dark theme, the on-light tile otherwise, with the alt text assets/alt-text.json declares for the light tile, "The Cosyte logo on its own white ground: the icon beside the word Cosyte." The logo links to cosyte.com.
  • Work with us (BI5, ST29). Every hire-us link ("Need it integrated? Talk to us", in the README and all ten starter READMEs) goes to https://cosyte.com/integration-services instead of /contact.
  • Campaign tags (BI6, ST30). Every cosyte.com and docs.cosyte.com link carries utm_source=github&utm_medium=readme&utm_campaign=evergreen&utm_content=examples.
  • AGENTS.md (RD3, ST26). A short AGENTS.md (what the repo is, build and test, the gate, synthetic data only), in the shape the libraries' AGENTS.md drafts use. CLAUDE.md imports it with @AGENTS.md and keeps only what it adds: what CI does with the gate, the hazard, and the rules. Every fact comes from the old CLAUDE.md.
  • House style (ST3, ST6, ST8). US spelling: "Summarize" in x12-remittance's package.json description, "labeled" in an x12-eligibility test name, "license" in a dash-gate comment. The serial comma in every list of three or more across the READMEs, with semicolons where a list nests inside another. The dash gate's error messages read check-no-emdash: ... instead of using a spaced hyphen as a pause. Program output in the expected-output blocks is unchanged.
  • Versions in prose (ST16). examples#13 moved every lockfile to the 0.1.1 releases (x12 0.1.2). The Limits notes now name the 0.1 line instead of 0.1.0, each checked against the new releases: synth's generated values, deid's 113-character method text, fhir's resolvePath list node, transform's silent PID-19 drop, x12's missing AAA and EB-01 tables and the 271 without a BHT. The same goes for three code comments. cli-tour's expected output shows the 0.1.1 it now prints for cosyte --version and the deid delegation line. ccda-summary's note about the @xmldom/xmldom 0.9.10 deprecation notice and audit advisories is gone, because ccda 0.1.1 pins 0.9.12, npm install prints no notice, and npm audit is clean. It now says only that ccda pins its XML parser exactly.
  • Legal name (ST2). LICENSE reads "Copyright (c) 2026 Cosyte LLC". No README carries a copyright line.

ST13 has nothing to change here: the README does not count the libraries.

Gate

  • bash scripts/check-no-emdash.sh passes, and so do this title, body, and commit message through --stdin.
  • npm ci and npm test pass in all ten starters on Node 22 and on Node 24, with no test weakened (one test name changed its spelling).
  • Every starter's expected-output block matches a fresh npm start on Node 24.

…rite to the house style

- README.md opens with the shared lockup tile pair in a picture element,
  as hl7's README does, with the alt text assets/alt-text.json declares
  for the light tile (BR4, ST20).
- Every hire-us link, in README.md and the ten starter READMEs, goes to
  /integration-services (BI5, ST29), and every cosyte.com and
  docs.cosyte.com link carries utm_source=github, utm_medium=readme,
  utm_campaign=evergreen, and utm_content=examples (BI6, ST30).
- AGENTS.md holds the build, the test, the gate, and the data rule, and
  CLAUDE.md imports it and keeps the CI notes, the hazard, and the rules
  (RD3, ST26).
- US spelling (ST3): "Summarize" in x12-remittance's package.json,
  "labeled" in an x12-eligibility test name, "license" in a dash-gate
  comment. The serial comma in every list of three or more across the
  READMEs (ST6). The dash gate's error messages use a colon, not a spaced
  hyphen (ST8).
- After the move to the 0.1.1 releases (x12 0.1.2): prose names the 0.1
  line instead of 0.1.0 where the fact still holds, checked against the
  new releases; cli-tour's expected output shows the 0.1.1 version lines
  it now prints; ccda-summary drops the @xmldom/xmldom 0.9.10 deprecation
  and audit note, which ccda 0.1.1 no longer triggers, and says only that
  ccda pins its XML parser exactly (ST16).

Every starter's expected output matches a fresh run, and npm ci and npm
test pass in all ten starters on Node 22 and 24.
ST2 puts the legal name in copyright lines: LICENSE now reads
"Copyright (c) 2026 Cosyte LLC". No README carries a copyright line.
@NSchatz
NSchatz merged commit aa321b7 into main Nov 7, 2026
29 checks passed
@NSchatz
NSchatz deleted the docs/readme-standards branch November 7, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant