Skip to content

Standardize docs automation and CI utility baseline #3

@cmccomb

Description

@cmccomb

Summary

Align design-research documentation helpers, badge generation, and CI utility scripts with the shared design-research docs automation baseline.

Current state

  • This repo currently has docs consistency and docstring checks, but not the richer badge-generation and example-reporting utilities present in some sibling repos.
  • As the umbrella package, it should have a deliberate answer for which automation is shared baseline and which utilities are module-specific.

Proposed work

  • Define the shared docs/CI utility baseline for the umbrella package.
  • Add or adapt missing badge-generation and related docs utilities where they make sense here.
  • Normalize workflow responsibilities for docs checks, badge updates, and release-facing documentation surfaces.
  • Document any utilities that should remain specific to component repos rather than the umbrella package.

Acceptance criteria

  • The repo matches the agreed shared baseline for docs/CI utilities.
  • Any intentionally omitted utilities are documented with rationale.
  • The umbrella repo's docs automation no longer lags the module repos.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions