All.tutorial template

<title>Tutorial Guide: script.py</title>

<section name="Introduction">

Introduction

    Provide a brief description of the task and what the script does.

    <bullet>TODO: Define the task at a high level</bullet>
    <bullet>TODO: Identify the key motivation or use case</bullet>

</section>

<section name="WhatYoullBuild">

What You'll Build

    Describe what the script produces or automates.
    <sample_behavior>
    <bullet>A Markdown file with diagram code blocks</bullet>
    <bullet>A script that processes and renders those diagrams</bullet>
    <bullet>A new output file with embedded images</bullet>
    </sample_behavior>

</section>

<section name="BeforeYouBegin">

Before You Begin

    Describe all prerequisites or setup conditions required.

    <bullet>Docker installed and running</bullet>
    <bullet>Linter up and running</bullet>
    <bullet>TODO: Any required environment variables or permissions</bullet>

</section>

<section name="UsingTheScript">

Using the Script

    Describe how to execute the script with examples.

    <sample_behavior>
    <code_block language="bash">

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

    <bullet>TODO: Explain the different flags</bullet>
    <bullet>TODO: Mention optional flags or parameters</bullet>
    </sample_behavior>

</section>

<section name="Output">

Output

    Explain what output is expected and how to validate it.

    <bullet>TODO: Describe where the output file is saved</bullet>
    <bullet>TODO: Mention format of embedded images or changes in the file</bullet>

</section>