Fix npm package README publishing#1256
Open
max-voloshyn wants to merge 2 commits into
Open
Conversation
max-voloshyn
commented
May 29, 2026
max-voloshyn
commented
May 29, 2026
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
@owox/api-clientso npm displays install guidance without duplicating the primary docs.@owox/ctldocs link with a directdocs.owox.comURL.fileslists and add regression tests for package-safe README links/content.Root Cause
@owox/api-clientdid not have aREADME.mdin its package directory, so the published npm package had no README.@owox/ctlshipped a README, but its documentation link pointed outside the package via../../docs/api/owox-ctl.md, which breaks when rendered on npm.Review Follow-up
The package READMEs now use public
docs.owox.comdocumentation links. The@owox/api-clientREADME is intentionally minimal and links to the canonical guide, API key docs, and OpenAPI docs instead of copying guide content into the npm package README.Validation
npm --cache /private/tmp/owox-npm-cache run test -w @owox/ctlnpm --cache /private/tmp/owox-npm-cache run test -w @owox/api-clientnpm --cache /private/tmp/owox-npm-cache run lint -w @owox/ctlnpm --cache /private/tmp/owox-npm-cache run lint -w @owox/api-clientnpm --cache /private/tmp/owox-npm-cache run format:check -w @owox/ctlnpm --cache /private/tmp/owox-npm-cache run format:check -w @owox/api-clientnpm --cache /private/tmp/owox-npm-cache run lint:md:all -- apps/ctl/README.md packages/api-client/README.mdnpm pack --dry-run --json --ignore-scripts --cache /private/tmp/owox-npm-cache -w @owox/ctlnpm pack --dry-run --json --ignore-scripts --cache /private/tmp/owox-npm-cache -w @owox/api-client