Documentation

Documentation

The repository's own markdown, rendered from commit fd90404 at 2026-09-25 23:24 UTC.

Using plumbline

  • README README.md
    What plumbline is, how to run it, and what it does not do.
  • Your own data docs/datasets.md
    The row format, what is refused and why, and the commands to run next.
  • Methodology METHODOLOGY.md
    How each figure is computed, and the floor each is reported against.
  • Example report docs/example-report.md
    One seeded mock run, rechecked against its command on every build.
  • Dataset datasets/public/README.md
    The vendored JevBench fixture: where it comes from and its license.

Project

  • Plan docs/PLAN.md
    What is built, what is deliberately not, and why.
  • Changelog CHANGELOG.md
    Notable changes per release.
  • Contributing CONTRIBUTING.md
    How to work on the code and what CI checks.
  • Security SECURITY.md
    How to report a vulnerability, and what the scanners cover.