Skip to content

Support repository-scale file discovery and publish a consumer CI workflow #33

Description

@cmungall

Priority: P1

Problem

The CLI accepts only individually enumerated paths, and even this repository hard-codes every example in the justfile. The docs promise that stale prose can be caught before it ships but provide no copy-paste consumer workflow.

This makes adoption cumbersome for repositories with many reports and leaves important CI choices undefined.

Acceptance criteria

  • Accept directories and recursively discover supported Markdown/HTML inputs.
  • Provide include/exclude patterns, deterministic ordering, duplicate handling, and symlink policy.
  • Define behavior for zero matches and unsupported extensions.
  • Offer one repository-wide command or documented composition covering lint, inspect, and verify.
  • Publish a copy-paste GitHub Actions workflow with pinned/reproducible installation and caching.
  • Explain warning/skip policy, JSON artifact retention, changed-file versus full-repo checks, and failure exit codes.
  • Include safe behavior for forked/untrusted pull requests without repository secrets.
  • Test discovery and the documented workflow against fixture repositories.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions