Skip to content

verify-docs does not cover README examples #177

Description

@myobie

npm run verify-docs checks docs/testing.md and docs/vrs. It does not check README.md.

From July 20, 2026, until September 5, 2026, the README install command returned 404 because the package was not published. The documentation gate passed throughout those 47 days.

README coverage would have caught the broken command on the first gate run. Before changing the gate, check which README blocks are safe to run in CI.

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions