Skip to content
This repository was archived by the owner on Nov 7, 2026. It is now read-only.

@eldrforge/shared 0.1.8 — Guide docs now shipped with the npm package

Choose a tag to compare

@tobrien tobrien released this 11 Jan 05:57
· 17 commits to working since this release
ebd504a

Main story

This release focuses on packaging and documentation: the published npm artifact now includes a guide/ directory with an “agentic guide” for @eldrforge/shared.

What changed

Documentation now included in published package

  • Added guide/ to the package.json files whitelist so it is included in the npm tarball.
  • Updated .npmignore so Markdown docs are still excluded by default, except:
    • README.md
    • guide/**/*.md
  • New doc: guide/index.md ("@eldrforge/shared – Agentic Guide") covering purpose, key features, example usage, and a quick overview of exports.

Why it matters: consumers (and tooling/agents that operate from installed dependencies) can now access project guidance and examples directly from node_modules/@eldrforge/shared/guide/ without needing to browse the repo.

Dev tooling

  • Bumped dev dependency @eldrforge/git-tools from ^0.1.17 to ^0.1.18.
    • This is a development-only change (build/lint/test workflow) and should not affect runtime consumers.

Impact

  • Users: No API or runtime behavior changes; you simply get additional packaged documentation.
  • Developers: The npm package contents now include guide/, which may slightly increase install size but improves local/offline documentation availability.

Breaking changes

  • None detected. No exports, runtime dependencies, or public APIs were changed in this release.