Skip to content

Add reusable CI/CD workflows for synchronized documentation #10

Description

@adrianbrowning

What to build

Make mdcode practical to adopt in CI/CD pipelines by providing a reusable documentation-synchronization check, runnable-example validation, and release gating. A consumer should be able to copy the examples and prevent stale Markdown code blocks from reaching production.

Acceptance criteria

  • The repository contains a documented end-to-end CI/CD integration path for mdcode.
  • The path checks that Markdown blocks are synchronized with their linked source files.
  • The path supports validating selected runnable examples.
  • The release path runs the relevant mdcode checks before a package is published.
  • Each deliverable is tracked as a child issue and can be completed independently.

Blocked by

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestready-for-humanRequires human implementation or external-account decisions

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions