/ 
Developer-Dashboard-3.26
/ sync-readme-from-pod

NAME

sync-readme-from-pod - regenerate the checkout manual from the main Developer::Dashboard POD

SYNOPSIS

script/sync-readme-from-pod
script/sync-readme-from-pod --stdout

DESCRIPTION

This checkout-only helper regenerates the project manual used by Markdown consumers from the canonical POD in Developer::Dashboard. It exists to keep the top-level manual and the main module documentation in exact sync and to avoid hand-edited drift between the two copies.

PURPOSE

Use this helper whenever the main module POD changes and the checkout manual must be refreshed before tests, build, or release gates.

INPUTS

  • no arguments

    Rewrite the checkout manual in place.

  • --stdout

    Print the generated manual to standard output instead of rewriting the file.

OUTPUT

Either the rewritten checkout manual on disk or the generated Markdown text on standard output.

EXAMPLES

script/sync-readme-from-pod
script/sync-readme-from-pod --stdout > /tmp/manual-preview

WHAT USES IT

Developers use this helper during documentation updates, and the release metadata tests use its --stdout mode to verify that the checked-in checkout manual still matches the generated output.