playrote.play.v1

ccmdr-chara/documentation-contract-refereev0.2.0Public

Documentation contract referee

Referees executable claims in README files and runbooks against repository evidence: commands, prerequisites, Markdown anchors, package scripts, Make targets, Just recipes, package manager, versions, and environment templates.

Read the full description

Returns a compact contract verdict with coverage, evidence, and fixes. Credential-free and never executes copied documentation commands.

  • Published 1 Sep 2026
  • Downloads 7
  • Needs rote 0.62.0+
  • Digest sha256:b386bad8aa13…
  • Reference cmdr-chara/documentation-contract-referee@0.2.0

Before you run it2 local tools

Everything here is checked on your machine when rote inspects the play. This page never learns what you have installed or which credentials you hold.

  • ○
    python3local tool

    Must be on your PATH when used. minimum version undeclared.

  • ○
    gitlocal tooloptional

    Must be on your PATH when used. minimum version undeclared.

Inputs6, all optional

rote asks for these before running and shows the defaults it will use.

  • Repo pathrepo_path

    Local repository path to inspect.

    optionalstringdefault .example .custom value allowed
  • Docs pathsdocs_paths

    Comma-separated repository-relative documentation files or directories.

    optionalstringdefault README.md,docsexample README.md,docs,runbookscustom value allowed
  • Max findingsmax_findings

    Maximum number of prioritized findings to display, from 1 to 10.

    optionalintegerdefault 3example 3custom value allowed
  • Baseline shabaseline_sha

    Optional git commit used to flag executable-contract changes made without documentation changes.

    optionalstringexample HEAD~1custom value allowed
  • Verificationverification

    Use static checks only, or execute reconstructed allow-listed CLI help forms without running copied commands.

    optionalstringdefault staticexample safe-help
    2 choices
    • static
    • safe-help
  • Demodemo

    Optional deterministic built-in demonstration; leave empty to inspect repo_path.

    optionalstringexample stale
    2 choices
    • coherent
    • stale

What it changes

No write operations are declared in this version's manifest.

Credentials remain in the recipient's local rote vault; this page and the publisher never receive them.

Runtime details
  • rote CLIversion 0.62.0 or newer
  • Servicesnone declared
  • Digestsha256:b386bad8aa139f28856699f0c247a2de1455061c045ef67f2434b0fb084fbb49
  • Archive size12403 bytes
  • Published2026-09-01T15:46:58.738118+00:00
  • Published withrote 0.77.0

Credential values and current readiness remain local. Opening this page never prompts for a credential, opens an authorization browser, or calls a service this play uses.

A play is a published, versioned automation package that runs on your own machine through rote, a free command-line tool. Opening this page installs nothing and runs nothing.