Skip to content

fix: ship the docs that the package README links to - #18

Merged
Karnaukhov-kh merged 1 commit into
mainfrom
fix/package-docs
Oct 20, 2026
Merged

Karnaukhov-kh merged 1 commit into
mainfrom
fix/package-docs

Conversation

@Karnaukhov-kh

@Karnaukhov-kh Karnaukhov-kh commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

The README in the 0.4.0 package links to 7 pages under docs/ and to the repository README, and the tarball contains neither. The links break wherever the README renders from the tarball, such as node_modules, unpkg, and jsDelivr.

  • files in package.json includes docs. The tarball grows from 113 to 120 files.
  • The link to the repository README points at GitHub, because that file sits outside the package.

Every relative link in the shipped Markdown files resolves inside the packed tarball.

npm renders the package README, not the repository's front page, so the package README now opens the same way: the logo, then Install and Quick start, followed by the explanation of the problem and how Iterward works. The logo uses absolute raw.githubusercontent.com URLs, because assets/ sits outside the package.

This change is also the first release through the workflows: nx release --skip-publish --dry-run resolves 0.4.0 from the iterward@0.4.0 tag and bumps the version to 0.4.1.

The README in the 0.4.0 package links to 7 pages under docs/ and to
the repository README, and the tarball contains neither. The links
break wherever the README renders from the tarball, such as
node_modules, unpkg, and jsDelivr.
@Karnaukhov-kh
Karnaukhov-kh merged commit ea1a288 into main Oct 20, 2026
1 check passed
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