Skip to content

README points at src/config/defaults.json, which is not in the npm package #79

Description

@BASIC-BIT

The configuration section of README.md ends with:

See src/config/defaults.json for all defaults.

src/ is not in the files array in package.json, so that path does not exist in the published tarball. Confirmed with npm pack --dry-run --json: 266 files ship, including README.md and assets/logo.svg, and zero of them are under src/.

The pointer resolves on GitHub, which is where the README is mostly read, so this is low impact. It is dead for anyone reading the README from the installed npm package or from an MCP client that surfaces the packaged README.

Options:

  • Link the GitHub blob URL instead of the bare path.
  • Or inline the handful of defaults the README already documents elsewhere.

Surfaced by review on #78 and deliberately left out of that PR, which was scoped to dependency bumps plus one generated-tool docs fix.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions