From umami's 0.10.0 dogfood (concern #2).
files: ["dist"] ships no markdown, and npm always includes README.md but does not reliably rewrite relative links — so the README's [writing tutorials](docs/writing-tutorials.md) etc. break on npmjs.com and from an installed package.
(The one shipped-code reference — the settleUntil JSDoc — was fixed to a hosted URL in PR #26.)
Options
- Recommended: rewrite README's relative
docs/*.md links to absolute https://github.com/jbrecht/tutorial-forge/blob/main/docs/... URLs. Lightest, fixes npm rendering, no package-size cost.
- Or bundle
docs/ into the package via files (heavier; unusual for a JS lib).
Pin to a tag instead of main if link drift across versions becomes a concern.
From umami's 0.10.0 dogfood (concern #2).
files: ["dist"]ships no markdown, and npm always includesREADME.mdbut does not reliably rewrite relative links — so the README's[writing tutorials](docs/writing-tutorials.md)etc. break on npmjs.com and from an installed package.(The one shipped-code reference — the
settleUntilJSDoc — was fixed to a hosted URL in PR #26.)Options
docs/*.mdlinks to absolutehttps://github.com/jbrecht/tutorial-forge/blob/main/docs/...URLs. Lightest, fixes npm rendering, no package-size cost.docs/into the package viafiles(heavier; unusual for a JS lib).Pin to a tag instead of
mainif link drift across versions becomes a concern.