All.how to guide template

<title>How-To Guide: script.py</title>

<section name="WhatItDoes">

What It Does

    <bullet>TODO: Explain the purpose of this script or workflow</bullet>
    <bullet>TODO: Describe what outcome or goal this achieves</bullet>

    <example>
        Automatically render images from fenced code blocks in Markdown using a custom Python script.
    </example>

</section>

<section name="AssumptionsRequirements">

Assumptions / Requirements

    <bullet>Docker installed and running</bullet>
    <bullet>Basic command-line familiarity</bullet>
    <bullet>TODO: List any additional dependencies or permissions</bullet>

</section>

<section name="Instructions">

Instructions

    <step name="Step1" title="Fetch Input">

Step 1: Fetch Input

        <description>TODO: Describe the input file(s) and how to prepare or provide them.</description>

        <code_block language="bash">

Example: Download Markdown input file

wget https://example.com/input.md -O input.md

    <step name="Step2" title="Describe Action">

Step 2: Describe Action

        <description>TODO: Describe the main script command to execute the action.</description>

        <code_block language="bash">

python render_images.py -i input.md -o output.md --action render

    <step name="Step3" title="Review Output">

Step 3: Review Output

        <description>TODO: Explain how to verify the results of the script run.</description>

        <code_block language="bash">

Preview the output file

cat output.md | less

</section>

<section name="Examples">

Examples

    <examples>
        <example title="Basic Render">
            <description>Render all diagrams in a Markdown file to embedded images.</description>
            <code_block language="bash">

python render_images.py -i diagrams.md -o diagrams.output.md --action render

        <example title="Render + Open in Browser">
            <description>Render diagrams and open the rendered file in browser preview.</description>
            <code_block language="bash">

python render_images.py -i diagrams.md --action render --run_dockerized

        <example title="Dry Run for Debugging">
            <description>Check what will be processed without rendering the output.</description>
            <code_block language="bash">

python render_images.py -i diagrams.md -o /tmp/preview.md --dry_run

</section>

<section name="Troubleshooting">

Troubleshooting

    <issue_block>
        <issue>TODO: Describe a common issue</issue>
        <cause>TODO: Likely cause</cause>
        <solution>TODO: Suggested fix or workaround</solution>
    </issue_block>

    <issue_block>
        <issue>TODO: Another possible issue</issue>
        <cause>TODO: Likely cause</cause>
        <solution>TODO: How to resolve it</solution>
    </issue_block>

</section>