Skip to content

docs: add practical example for custom slash command "/explain-this-file" in README #106

@94tianqi

Description

@94tianqi

This PR adds a complete, ready-to-use example for a custom slash command /explain-this-file to the README's "Custom Slash Commands" section.

Why this is useful:

  • Helps new users understand how to create powerful, reusable prompts.
  • Demonstrates frontmatter + multi-step reasoning in a real-world scenario (explaining the current file).
  • Complements existing examples like /code-review and /bug-fix.

Changes:

  • Added a new code block under "Custom Slash Commands" with file path, frontmatter, and prompt content.
  • Minor wording tweaks for clarity.

Example added:

Create file: .augment/commands/explain-this-file.md

---
description: Explain the current file in detail
---

You are an expert code explainer.

For the file @file, provide a clear, structured explanation including:

1. **Purpose**: What does this file do overall?
2. **Key Components**: Main functions/classes/exports and their roles.
3. **Data Flow**: How data moves through the file (if applicable).
4. **Potential Improvements**: Any quick suggestions for readability or performance.

Use markdown formatting, code snippets where helpful, and keep it concise but thorough.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions