Skip to content

Comments

Add visual hierarchy and progressive disclosure to Safe Outputs documentation#10411

Closed
Copilot wants to merge 3 commits intomainfrom
copilot/add-visual-hierarchy-to-docs
Closed

Add visual hierarchy and progressive disclosure to Safe Outputs documentation#10411
Copilot wants to merge 3 commits intomainfrom
copilot/add-visual-hierarchy-to-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 17, 2026

The Safe Outputs reference is comprehensive (~40KB) but presented as a flat wall of text, making it difficult to quickly find relevant operations. This restructures the page with progressive disclosure and task-oriented navigation.

Changes

  • Quick Reference table: 7 most common operations (create-issue, create-pull-request, add-comment, etc.) with direct anchor links
  • Decision Guide table: Maps user goals ("Report findings", "Propose code changes") to appropriate safe outputs with contextual notes
  • Collapsible category sections with emoji icons for visual differentiation:
    • 🎯 Issues & Discussions, 🔀 Pull Requests, 🏷️ Labels/Assignments (open by default)
    • 📦 Projects/Releases, 🔒 Security, ⚙️ System Types, 🛠️ Custom Jobs (collapsed by default)
  • Configuration section: Advanced options (tokens, security, sanitization) wrapped in collapsible details

All content preserved. All anchor links verified.

Screenshots

Quick Reference:
Quick Reference

Decision Guide:
Decision Guide

Collapsible Sections:
Collapsible Sections

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://storage.googleapis.com/chrome-for-testing-public/143.0.7499.4/linux64/chrome-headless-shell-linux64.zip
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node /opt/hostedtoolcache/node/24.12.0/x64/bin/node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/playwright-core/lib/server/registry/oopDownloadBrowserMain.js (http block)
  • https://storage.googleapis.com/chrome-for-testing-public/143.0.7499.4/linux64/chrome-linux64.zip
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node /opt/hostedtoolcache/node/24.12.0/x64/bin/node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/playwright-core/lib/server/registry/oopDownloadBrowserMain.js (http block)
  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro preview (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Add visual hierarchy and progressive disclosure to Safe Outputs documentation</issue_title>
<issue_description>## Objective

Restructure docs/src/content/docs/reference/safe-outputs.md with visual hierarchy and progressive disclosure to help users quickly find the right safe output for their task.

Context

Parent Issue: This is part of the user experience improvements tracked in the parent issue.

Source: Delight Audit identified that the Safe Outputs reference documentation (~40KB) is comprehensive but overwhelming with flat structure and no visual differentiation.

Current State: Wall of text without visual breaks or quick navigation.

Target State: Scannable, progressive disclosure with quick reference, visual grouping, and decision support.

Approach

  1. Add Quick Reference table at the top with 5-7 most common operations (create_issue, create_pull_request, add_comment, etc.)
  2. Wrap each category in <details> tags for progressive disclosure
  3. Add visual emoji icons for categories:
    • 🎯 Issues
    • 🔀 Pull Requests
    • 🏷️ Labels
    • 💬 Comments
    • 🔒 Security
    • 📝 Discussions
  4. Create a decision guide (table or diagram) showing "What do you want to do?" → "Use this safe output"
  5. Keep all existing detailed documentation intact (no content removal)
  6. Ensure all internal links work correctly after restructuring

Files to Modify

  • docs/src/content/docs/reference/safe-outputs.md

Acceptance Criteria

  • Quick Reference table added at the top
  • Each category wrapped in <details> tags with appropriate emoji icons
  • Decision guide (table or diagram) created
  • All existing content preserved
  • All internal links verified and working
  • Documentation renders correctly in Astro Starlight
  • Delight rating target: 🙂 Good → 😍 Delightful

Why This Matters

User Impact: Reduces cognitive load and time to find information from "scroll and search" to "quick reference lookup".

Frequency: High - this is reference documentation users consult repeatedly throughout workflow development.

AirBnB Principles: Attention to Detail, Hick's Law (reduce choices), Visual Hierarchy

Size

Large file (~40KB) - significant restructuring required but no content changes.

AI generated by Plan Command for discussion #10343

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 17, 2026 04:12
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
…entation

- Add Quick Reference table with 7 most common safe outputs
- Add Decision Guide table mapping user goals to safe outputs
- Wrap categories in collapsible <details> tags with emoji icons:
  - 🎯 Issues & Discussions (open by default)
  - 🔀 Pull Requests (open by default)
  - 🏷️ Labels, Assignments & Reviews (open by default)
  - 📦 Projects, Releases & Assets (collapsed by default)
  - 🔒 Security & Agent Tasks (collapsed by default)
  - ⚙️ System Types (collapsed by default)
  - 🛠️ Custom Safe Output Jobs (collapsed by default)
- Wrap Configuration & Advanced Options in collapsible section
- All existing content preserved with no removals
- All internal anchor links verified and working
- Documentation builds and renders correctly in Astro Starlight

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add visual hierarchy and progressive disclosure to Safe Outputs documentation Add visual hierarchy and progressive disclosure to Safe Outputs documentation Jan 17, 2026
Copilot AI requested a review from mnkiefer January 17, 2026 04:20
@pelikhan pelikhan marked this pull request as ready for review January 17, 2026 10:14
@pelikhan pelikhan closed this Jan 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[plan] Add visual hierarchy and progressive disclosure to Safe Outputs documentation

3 participants