Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 6, 2026

The documentation index repeated the workflow process (write markdown → compile → run) in both prose and numbered list. The security section used bold text instead of a proper heading, making it hard to scan and excluded from the TOC. Additionally, the "Perfect for" section was removed to streamline the content.

Changes

  • Removed duplicate workflow explanation — Deleted redundant sentence from intro paragraph; kept only the structured "How it works" list
  • Upgraded security header — Changed **Security built-in:** to ### Security Built-In for proper visual hierarchy and TOC inclusion
  • Removed "Perfect for" section — Removed the use case examples (Issue triage, PR reviews, Repository maintenance) for a cleaner, more focused introduction

Before/After

Before:

Install it with `gh extension install githubnext/gh-aw`, write workflows in markdown (`.md` files), compile them with `gh aw compile`, and GitHub Actions runs the generated workflows (`.lock.yml` files). Instead of writing complex YAML...

**How it works:**
1. **Write** - Create a `.md` file...
2. **Compile** - Run `gh aw compile`...

**Perfect for:**
- 🤖 **Issue triage** - Automatically categorize, label, and respond to new issues
- 🔍 **PR reviews** - Get AI-powered code reviews and suggestions
- 🔧 **Repository maintenance** - Automate dependency updates, documentation, and cleanup tasks

**Security built-in:**
Workflows run with read-only permissions...

After:

Instead of writing complex YAML configurations, you describe your automation goals in plain markdown...

**How it works:**
1. **Write** - Create a `.md` file...
2. **Compile** - Run `gh aw compile`...

### Security Built-In

Workflows run with read-only permissions...

Screenshots

Streamlined Homepage

The page now flows directly from "How it works" to "Security Built-In" for a cleaner, more focused introduction.

[!WARNING]

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using Astro Starlight and GitHub Docs voice

Original prompt

Review docs index.mdx and remove the duplicate wording about write Md, compile, lock file

make safe title header higher header, too small

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using Astro Starlight and GitHub Docs voice


💡 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 AI self-assigned this Jan 6, 2026
Copilot AI changed the title [WIP] Remove duplicate wording in index.mdx docs: remove duplicate workflow explanation and upgrade security section to h3 Jan 6, 2026
Copilot AI requested a review from pelikhan January 6, 2026 14:02
@pelikhan
Copy link
Contributor

pelikhan commented Jan 6, 2026

@copilot remove perfect for section

Copy link
Contributor Author

Copilot AI commented Jan 6, 2026

@copilot remove perfect for section

Removed the "Perfect for" section in commit 4d307c6.

Updated homepage

The page now flows directly from "How it works" to "Security Built-In" for a cleaner introduction.

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:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/20.19.6/x64/bin/node node /home/REDACTED/.npm/_npx/aa98e6899c6baff3/node_modules/.bin/astro dev --host 0.0.0.0 --port 4321 (dns block)
    • Triggering command: /opt/hostedtoolcache/node/20.19.6/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev (dns block)

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

Copilot AI changed the title docs: remove duplicate workflow explanation and upgrade security section to h3 docs: streamline homepage by removing duplicates and improving structure Jan 6, 2026
@pelikhan pelikhan marked this pull request as ready for review January 6, 2026 14:29
@pelikhan pelikhan merged commit 8449709 into main Jan 6, 2026
3 checks passed
@pelikhan pelikhan deleted the copilot/remove-duplicate-wording branch January 6, 2026 14:29
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.

2 participants