Add "How It Works" section to README with concrete example, workflow diagram, and security benefits

[Copilot]

Enhances the README to make it clearer what GitHub Agentic Workflows is about by adding a new "How It Works" section with a concrete example, visual diagram, and security information.

What's Changed

The README now includes a practical demonstration of the core concept: transforming natural language markdown into executable GitHub Actions workflows. The new section shows:

Concrete Example: A simple issue auto-responder workflow that demonstrates:

• Frontmatter configuration (triggers, read-only permissions, safe outputs)
• Natural language instructions for the AI agent
• Real-world use case that's easy to understand

Visual Flow Diagram: A mermaid diagram illustrating the complete workflow:

Markdown → gh aw compile → GitHub Actions YAML → AI Agent → Intelligent Actions

Clear Explanation: Plain English summary explaining that "the AI agent reads your repository context, understands the issue content, and takes appropriate actions - all defined in natural language rather than complex code."

Security Benefits: Brief explanation of the security model including read-only permissions by default, sanitized safe-outputs for write operations, and team member access gating.

Why This Helps

The original README jumped straight to documentation links without showing what the tool actually does. New users can now immediately see:

• What input they provide (natural language markdown)
• What the tool generates (GitHub Actions workflows)
• How AI agents execute the workflows
• What kinds of intelligent actions result
• The security safeguards in place

The example chosen (issue auto-responder) is simple enough for newcomers but demonstrates key concepts like event triggers, permissions, and safe outputs that make agentic workflows powerful and secure.

This addresses the issue request for "a short example of agentic workflow and a mermaid diagram of the generated workflow" with minimal changes that enhance clarity without disrupting the existing content structure.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[pelikhan]

@copilot explain briefly the security benefits: read only permissions, gating to team members, output sanitization

[pelikhan]

@copilot permissions should be read-all . Write is done in the safe outputs

[Copilot]

Updated the permissions to use read-all in the example (commit 78be9e9). Write operations are now clearly handled through safe-outputs as intended.

[Copilot]

@copilot explain briefly the security benefits: read only permissions, gating to team members, output sanitization

Added a "Security Benefits" section explaining the three key security features: read-only permissions by default, sanitized safe-outputs for write operations, and team member access gating (commit 78be9e9).

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• api.contoso.com
  • Triggering command: /tmp/go-build3321410897/b278/cli.test -test.testlogfile=/tmp/go-build3321410897/b278/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[pelikhan]

@dsyme a small update to the readme to make it a bit more real

[dsyme]

I get what you're doing here, though somehow I think any README-based landing page in a githubnext repo just isn't going to cut it. We need a proper landing page, and best to get people to it as soon as possible rather than hanging around in the repo

[pelikhan]

I can get a Astro starlight documentation site going as well on the side but I wanted to show the simplicity here. Probably make this sample even shorter.