Repository navigation
fix: ship the docs that the package README links to - #18
Merged
Merged
Conversation
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.
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.
The README in the
0.4.0package links to 7 pages underdocs/and to the repository README, and the tarball contains neither. The links break wherever the README renders from the tarball, such asnode_modules, unpkg, and jsDelivr.filesinpackage.jsonincludesdocs. The tarball grows from 113 to 120 files.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.comURLs, becauseassets/sits outside the package.This change is also the first release through the workflows:
nx release --skip-publish --dry-runresolves0.4.0from theiterward@0.4.0tag and bumps the version to0.4.1.