Skip to content

Standardize docs automation and CI utility baseline #63

@cmccomb

Description

@cmccomb

Summary

Align design-research-problems documentation helpers, badge generation, catalog generation, and CI utility scripts with the shared design-research module standard.

Current state

  • This repo already has badge-generation utilities and example metrics similar to design-research-agents.
  • It also has a repo-specific catalog generator (generate_problem_catalog_docs.py) that should be evaluated as part of the shared docs automation story.
  • We need a cleaner answer for what is shared baseline versus what is problem-catalog-specific.

Proposed work

  • Define the shared docs/CI utility baseline across the module repos.
  • Align existing badge-generation and example-reporting utilities with that shared baseline.
  • Clarify how the problem-catalog generator fits into the shared docs automation model.
  • Normalize workflow responsibilities for docs checks, badge updates, and generated docs outputs.

Acceptance criteria

  • Shared utilities and problem-specific utilities are clearly distinguished.
  • The repo matches the agreed common baseline for docs/CI utilities.
  • Catalog-generation automation fits cleanly into the broader docs standardization effort.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions