Objective
Fix the misleading classification of cache-memory in the frontmatter documentation to accurately reflect that it's a tools configuration, not a top-level frontmatter field.
Context
The schema consistency check (discussion #3589) found that the documentation lists cache-memory as a "frontmatter element" at the same level as top-level fields like engine, network, permissions, etc. However, cache-memory is actually nested under tools: configuration (properties.tools.properties.cache-memory).
Impact:
- Users might incorrectly place
cache-memory: at the top level instead of inside tools:
- Documentation structure doesn't match actual YAML structure
- Inconsistent with how other tools configurations are presented
Approach
- Review the frontmatter elements introduction in
frontmatter.md
- Reorganize the list to distinguish between:
- Top-level frontmatter fields:
on, permissions, engine, network, strict, timeout-minutes, etc.
- Tools configuration:
cache-memory, bash, edit, github, web-fetch, web-search, MCP servers, etc.
- Update any examples or references that might suggest cache-memory is top-level
- Ensure the reorganization maintains clarity and doesn't introduce new confusion
Files to Modify
docs/src/content/docs/reference/frontmatter.md:25 - Update frontmatter elements categorization
Example Structure
## Frontmatter Elements
### Top-Level Configuration
Core workflow settings that appear at the root level:
- `on:` - Workflow triggers
- `permissions:` - GitHub token permissions
- `engine:` - AI processor configuration
- `network:` - Network access control
- `timeout-minutes:` - Workflow timeout
- [etc.]
### Tools Configuration
Tool availability and settings under the `tools:` key:
- `cache-memory:` - Persistent memory storage
- `bash:` - Shell command tools
- `edit:` - File editing tools
- `github:` - GitHub API tools
- `web-fetch:` - Web content fetching
- [etc.]
Acceptance Criteria
Related Documentation
AI generated by Plan Command for discussion #3589
Objective
Fix the misleading classification of
cache-memoryin the frontmatter documentation to accurately reflect that it's a tools configuration, not a top-level frontmatter field.Context
The schema consistency check (discussion #3589) found that the documentation lists
cache-memoryas a "frontmatter element" at the same level as top-level fields likeengine,network,permissions, etc. However,cache-memoryis actually nested undertools:configuration (properties.tools.properties.cache-memory).Impact:
cache-memory:at the top level instead of insidetools:Approach
frontmatter.mdon,permissions,engine,network,strict,timeout-minutes, etc.cache-memory,bash,edit,github,web-fetch,web-search, MCP servers, etc.Files to Modify
docs/src/content/docs/reference/frontmatter.md:25- Update frontmatter elements categorizationExample Structure
Acceptance Criteria
tools:key where applicableRelated Documentation
docs/src/content/docs/reference/frontmatter.md:25- Current documentationpkg/parser/schemas/main_workflow_schema.json- Schema showing cache-memory under toolsRelated to [Schema Consistency] 🔍 Schema Consistency Check - 2025-11-11: Network & MCP Integration Analysis #3589