Objective
Develop conceptual explanation documentation that clarifies and illuminates how GitHub Agentic Workflows work, complementing the task-oriented and reference documentation.
Context
The Diátaxis framework's fourth quadrant (Explanation) is currently missing from the documentation. These understanding-oriented pages help users build mental models of how the system works, which is essential for effective use of advanced features.
Approach
Create new explanation pages in docs/src/content/docs/explanation/ that focus on concepts rather than tasks:
Core explanations needed:
- How Agentic Workflows Work - Architecture and execution model
- Security Model - Permission separation, safe outputs, XPIA protection
- Compilation Process - Markdown to YAML transformation
- Engine Comparison - When to use Copilot vs Claude vs Codex
- MCP Server Architecture - How tools integrate with workflows
- Safe Outputs Design - Why and how safe outputs provide security
Content approach:
- Focus on "why" and "how" rather than "what" and "how to"
- Use diagrams and visual aids
- Explain design decisions and tradeoffs
- Link to relevant tutorials and how-tos
Files to Create
docs/src/content/docs/explanation/architecture.md - How agentic workflows work
docs/src/content/docs/explanation/security-model.md - Security and permission design
docs/src/content/docs/explanation/compilation.md - Compilation process explained
docs/src/content/docs/explanation/engine-comparison.md - Choosing the right engine
docs/src/content/docs/explanation/mcp-architecture.md - MCP server integration
docs/src/content/docs/explanation/safe-outputs-design.md - Safe outputs philosophy
Files to Update
- Move: Conceptual content from
docs/src/content/docs/start-here/concepts.md to explanation section
- Update: Cross-references from tutorials and how-tos to explanation pages
Acceptance Criteria
Related to
Issue #1433
Related to #1433
AI generated by Plan Command
Objective
Develop conceptual explanation documentation that clarifies and illuminates how GitHub Agentic Workflows work, complementing the task-oriented and reference documentation.
Context
The Diátaxis framework's fourth quadrant (Explanation) is currently missing from the documentation. These understanding-oriented pages help users build mental models of how the system works, which is essential for effective use of advanced features.
Approach
Create new explanation pages in
docs/src/content/docs/explanation/that focus on concepts rather than tasks:Core explanations needed:
Content approach:
Files to Create
docs/src/content/docs/explanation/architecture.md- How agentic workflows workdocs/src/content/docs/explanation/security-model.md- Security and permission designdocs/src/content/docs/explanation/compilation.md- Compilation process explaineddocs/src/content/docs/explanation/engine-comparison.md- Choosing the right enginedocs/src/content/docs/explanation/mcp-architecture.md- MCP server integrationdocs/src/content/docs/explanation/safe-outputs-design.md- Safe outputs philosophyFiles to Update
docs/src/content/docs/start-here/concepts.mdto explanation sectionAcceptance Criteria
Related to
Issue #1433
Related to #1433