Skip to content

[plan] Create schema design philosophy documentation page #10221

@github-actions

Description

@github-actions

Objective

Create docs/src/content/docs/reference/schema-design.md documenting the security model and design philosophy behind main vs included workflow schemas.

Context

Users need to understand when to use main workflows vs included files, and why certain properties are restricted. This philosophical foundation is currently undocumented.

Approach

Create new documentation page covering:

  1. Security Model Overview

    • Main workflows: full capabilities, trusted entry points
    • Included files: restricted capabilities, reusable components
  2. Property Availability Matrix

    • Table showing which properties work in main vs included
    • 38 properties in main, 15 in included, 13 common
  3. Design Rationale

    • Why engine.command is main-only (security)
    • Why MCP config is simplified in included (sandboxing)
    • Why triggers (on) are main-only (semantic model)
  4. Usage Guidance

    • When to create a main workflow
    • When to create an included file
    • Migration strategies
  5. Examples

    • Valid main workflow with full capabilities
    • Valid included file with restricted config
    • Common mistakes and how to fix them

Files to Create

  • docs/src/content/docs/reference/schema-design.md

Acceptance Criteria

AI generated by Plan Command for discussion #10151

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions