Skip to content

[task] Reclassify cache-memory as tools configuration in frontmatter documentation #3595

Description

@github-actions

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

  1. Review the frontmatter elements introduction in frontmatter.md
  2. 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.
  3. Update any examples or references that might suggest cache-memory is top-level
  4. 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

  • Documentation clearly distinguishes top-level fields from tools configuration
  • cache-memory is correctly categorized under tools configuration
  • Examples show cache-memory under the tools: key where applicable
  • No confusion about configuration hierarchy
  • Other tools are similarly and consistently categorized

Related Documentation

AI generated by Plan Command for discussion #3589

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions