docs: document consuming the registry as an npm dependency - #170
Merged
lmcorbalan merged 21 commits intoSep 3, 2026
Conversation
12 tasks
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.
Summary
Closes #163
A downstream repository had no instructions for consuming the registry service, and five earlier changes in this epic left several documents describing an install lifecycle and a CI pipeline that no longer exist.
Changes
README.mdgains a "Consuming the registry service" section: the pinned dependency line, the git-credentials and participant preconditions, the full environment, and the pnpm build-script allowlist without which a pnpm install fails outright.CLAUDE.md,ARCHITECTURE.mdandSPEC.mdgain the two new commands, the third CI check and both new scripts;SPEC.md's size figures are re-derived and now name the command that produced them.RUNBOOK.mdstates that everyv[0-9]*tag is a DAR release, the npm pin included.Acceptance criteria
package.json'sdescriptionis edited, so the diff carries one non-.mdfile. That was the chosen resolution of the issue's own comment asking for a decision on the shipped manifest.Test plan
Automated tests
npm run check:depsexit 0. Thedamlcheck's ungated README-snippet comparison, extracted fromci.ymland run locally, printsok.Manual verification
Every documented command was run literally from a scratch consumer outside the repository, against the real private repo, on npm 9.2.0 and pnpm 11.25.0: the install links the bin and running it exits 1 naming
LEDGER_API_URL, and pnpm reproduces the documented refusal until the allowlist entry is added. The README's yaml block was extracted and parsed. All four line counts and the 24-entry package listing were re-derived.Breaking changes
None