Skip to content

[task] Implement progressive disclosure in reference documentation #1452

Closed as not planned

Description

@github-actions

Objective

Reduce cognitive load in reference documentation by using progressive disclosure patterns to hide advanced configuration options behind expandable sections.

Context

Microsoft's research on information architecture emphasizes progressive disclosure as a core design strategy. The scout report recommends minimizing initial complexity while keeping advanced features accessible.

Approach

  1. Restructure docs/src/content/docs/reference/frontmatter.md to separate core fields from advanced options
  2. Use <details> tags for advanced configuration sections
  3. Create "Simple" vs "Advanced" tabbed examples where appropriate
  4. Add visual markers (callouts, tips, warnings) to guide attention

Pattern to apply:

## Core Frontmatter Fields (Start Here)
- `on:` - Workflow triggers
- `permissions:` - Token permissions  
- `engine:` - AI processor

<details>
<summary>Advanced Frontmatter Fields</summary>

- `tools:` - Tool configuration
- `network:` - Network access control
- `cache:` - Dependency caching
- `safe-outputs:` - Output processing

</details>

Files to Modify

  • Update: docs/src/content/docs/reference/frontmatter.md - Add progressive disclosure
  • Update: docs/src/content/docs/reference/tools.md - Separate basic from advanced tools
  • Update: docs/src/content/docs/reference/safe-outputs.md - Use expandable sections
  • Update: docs/src/content/docs/reference/network.md - Progressive permission examples
  • Update: docs/src/content/docs/reference/engines.md - Basic vs advanced engine config

Acceptance Criteria

  • Core configuration options are immediately visible
  • Advanced options are behind expandable sections
  • Each reference page starts with simplest use cases
  • Visual markers (callouts) highlight important concepts
  • Page structure follows consistent pattern across reference docs
  • Build completes without errors

Related to

Issue #1433
Related to #1433

AI generated by Plan Command

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