Skip to content

Latest commit

 

History

History

README.md

Templates

This folder contains reusable templates for all content types in the course repository.

Available Templates

Template Purpose Used for
module-readme-template.md Standard structure for module README files (theory + guided prompt examples) /modules/XX-*/README.md
summary-template.md Standard structure for module summaries (key takeaways + Self-Check) /modules/XX-*/summary.md
prompt-template.md Standard structure for prompt library entries /prompts/**/*.md
agent-definition-template.md Standard structure for agent persona definitions /agents/*.md

Usage

When creating a new module, summary, prompt, or agent definition:

  1. Copy the relevant template.
  2. Replace all [PLACEHOLDER] values.
  3. Delete comment blocks (<!-- -->).
  4. Verify against the completion criteria section.

Contributing

If you improve a template, open a PR and explain the rationale. A template change affects all future content, so include a migration note in the PR description.