You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Code Quality] Add progressive disclosure to frontmatter documentation #14088
The frontmatter reference documentation (docs/src/content/docs/reference/frontmatter.md) presents all 25+ configuration options linearly, creating cognitive overload for users. New users face a wall of information when they likely need only 3-5 fields to start, while expert users must scroll through extensive documentation to find advanced features.
Suggested Changes
Restructure the documentation using progressive disclosure:
Add a "Quick Reference" section at the top with the 5 most common fields:
on: (trigger configuration)
permissions: (access control)
engine: (AI engine selection)
tools: (tool configuration)
Basic example
Organize remaining content using collapsible <details> sections by topic:
Core Workflow Settings
Advanced Settings
Security & Network
Testing & Debugging
Keep comprehensive documentation intact but hidden behind expandable sections
Files Affected
docs/src/content/docs/reference/frontmatter.md (lines 23-27 and subsequent sections)
Success Criteria
Quick reference section added with 5 core fields and minimal example
At least 3 major documentation sections wrapped in <details> tags
Time-to-comprehension for new users reduced from 10+ minutes to 2-3 minutes
Activity
github-actions commentedon Feb 7, 2026
This issue was automatically closed because it expired on 2026-02-07T09:12:14.578Z.