Skip to content

fix(package): include guide docs in npm package#1976

Open
gauravsaxena1997 wants to merge 1 commit into
jackwener:mainfrom
gauravsaxena1997:codex/fix-package-docs-discovery
Open

fix(package): include guide docs in npm package#1976
gauravsaxena1997 wants to merge 1 commit into
jackwener:mainfrom
gauravsaxena1997:codex/fix-package-docs-discovery

Conversation

@gauravsaxena1997

Copy link
Copy Markdown
Contributor

Summary

  • include docs/guide/ in the npm package whitelist
  • keep README links such as ./docs/guide/extending-opencli.md valid for installed-package readers

Fixes #1918.

Verification

  • node -e "const pkg = require('./package.json'); if (!pkg.files.includes('docs/guide/')) process.exit(1); console.log('docs/guide/ is included in package files')"
  • npm pack --dry-run --json showed docs/guide/extending-opencli.md in the package file list; this worktree does not have local dev dependencies installed, so npm prepare printed missing tsx/tsc tooling during the dry run.

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.

docs/ excluded from npm tarball — README 'Extending OpenCLI' link is dead for installed users; override mechanism undiscoverable

1 participant