Project Teacher

Generate a detailed explanation of the current project or task, focusing on the "why" and "how" to help the user learn.

Usage

When triggered, generate a markdown file containing the learning resource.

1. Check for Existing Documents (Synchronization)

Before generating a new file, search the output directory (default: learning/) for existing documents related to the current project.

• If a match is found: Ask the user: "I found an existing learning doc '[Filename]'. Do you want to update it or create a new snapshot?"
• If User chooses Update:
  1. Rename: Updates the suffix date to today's date (e.g., API_Layout - 2024-03-25.md) to reflect freshness.
  2. Metadata: Update the last and commit fields in the frontmatter.
  3. Content: Rewrite sections that are outdated, but preserve valuable historical context if it still applies.
  4. Log: Add a line to a ## Version history section at the bottom (create one if missing).
• If User chooses New / No match found: Create a new file.