Skip to content

Make docs reachable from the published package (README relative links break on npm) #27

@jbrecht

Description

@jbrecht

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions