Skip to content

gen-block-docs: assert/stub promised per-block docs so the docs contract can't drift #322

Description

@Simone319

Follow-up from PR #124 review (thread on packages/blocks/README.md). The README + scaffolded AGENTS.md tell agents each block ships README/API/DESIGN/CHANGELOG, but gen-block-docs.mjs only mirrors whatever *.md a package happens to have (today: core lacks DESIGN.md; hosting & pipeline lack API.md and DESIGN.md). PR #124 softened the wording to 'where present' (option a). Durable fix (option b): have gen-block-docs.mjs assert the promised files exist (or emit a stub) so the documented contract can't drift from what actually ships.

Metadata

Metadata

Assignees

No one assigned

    Labels

    pending-maintainer-responseWaiting on a response from the maintainerspending-triageIssue is pending triage by the maintainers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions