Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 25, 2025

The README lacked a visual representation of how the tool assembles context output, making it harder for users to understand the structure of the generated prompt.

Changes

  • Added ASCII diagram showing the four-component structure:

    1. Task frontmatter (YAML metadata)
    2. Skills metadata (XML, optional)
    3. Rules content (markdown)
    4. Task content (markdown)
  • Positioned at top of README after description, before Features section

The diagram illustrates the output order and key characteristics of each component (format, purpose, conditional inclusion).

┌─────────────────────────────────────────────────────────────┐
│ Generated Coding Context Prompt                             │
├─────────────────────────────────────────────────────────────┤
│  ┌───────────────────────────────────────────────────────┐  │
│  │ 1. Task Frontmatter (YAML)                            │  │
│  │    • Task metadata (selectors, agent, etc.)           │  │
│  └───────────────────────────────────────────────────────┘  │
│  ┌───────────────────────────────────────────────────────┐  │
│  │ 2. Skills Metadata (XML) - Optional                   │  │
│  └───────────────────────────────────────────────────────┘  │
│  ┌───────────────────────────────────────────────────────┐  │
│  │ 3. Rules Content (Markdown)                           │  │
│  └───────────────────────────────────────────────────────┘  │
│  ┌───────────────────────────────────────────────────────┐  │
│  │ 4. Task Content (Markdown)                            │  │
│  └───────────────────────────────────────────────────────┘  │
└─────────────────────────────────────────────────────────────┘
Original prompt

The read me should start with a diagram of the structure of the coding context prompt generated.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copilot AI changed the title [WIP] Add diagram of coding context structure to readme Add diagram showing generated prompt structure to README Dec 25, 2025
Copilot AI requested a review from alexec December 25, 2025 18:13
@alexec alexec marked this pull request as ready for review December 25, 2025 18:35
Copilot AI review requested due to automatic review settings December 25, 2025 18:35
@alexec alexec enabled auto-merge (squash) December 25, 2025 18:35
@alexec alexec merged commit 3a4c369 into main Dec 25, 2025
5 checks passed
@alexec alexec deleted the copilot/add-diagram-to-readme branch December 25, 2025 18:36
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a visual ASCII diagram to the README that illustrates how the tool assembles the generated context output. The diagram shows the four-component structure (task frontmatter, skills metadata, rules content, and task content) along with their key characteristics and when each component is included. This documentation enhancement makes it easier for users to understand the structure and order of the generated prompt without needing to read through detailed documentation or examine the code.

  • Added comprehensive ASCII diagram showing the four-component output structure
  • Included descriptive bullet points for each component explaining their purpose and characteristics
  • Added "Key Points" section summarizing the role of each component
  • Positioned strategically at the top of README (after description, before Features) for immediate visibility

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants