craft3-beam icon indicating copy to clipboard operation
craft3-beam copied to clipboard

Implement progressive disclosure in README

Open Copilot opened this issue 1 month ago • 0 comments

The README presented all content at once (119 lines), creating cognitive overload for new users while making it harder for experienced users to find specific information.

Changes

Progressive Disclosure (7 collapsible sections)

  • Configuration methods (setFilename, setHeader, setContent)
  • Common use cases (entry exports, commerce orders, formatted numbers)
  • Legacy version support (Craft 3.x, 4.x)

Information Architecture

  • Table of contents with deep links
  • Quick Start section with minimal working example
  • Logical flow: Basic → Advanced → Examples
  • 277 total lines, ~127 visible initially (~150 hidden in <details> tags)

Content Updates

  • Requirements updated to Craft CMS 5.0.0, PHP 8.0.2
  • Package name clarification (craft3-beam supports all Craft versions)
  • GitHub badges, improved formatting
  • Branch references updated (main vs master)

Result

## Quick Start
Generate a CSV file with just a few lines:
```twig
{% set beam = craft.beam.create({
    header: ['Name', 'Email'],
    content: [['John Doe', '[email protected]']]
}) %}
{% do beam.csv() %}
Export Entry Data [20 lines of detailed example, collapsed by default]
```

Users get immediate value from Quick Start, then explore progressively. Documentation appears 7% shorter while being 132% more comprehensive.

Original prompt

See if you can improve the readme, potentially with progressive disclosure


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot avatar Jan 06 '26 09:01 Copilot