Skip to content

[docs] docs: remove bloat from CLI commands documentation #4616

@github-actions

Description

@github-actions

Summary

Cleaned up docs/src/content/docs/setup/cli.md by removing redundant and verbose content while preserving all essential technical information.

Changes Made

Removed Bloat

  • Duplicate Quick Start section - Already covered in "Most Common Commands" table at the top
  • Verbose "What it does" bullet lists - Consolidated into concise prose throughout
  • Redundant options tables - Converted to inline descriptions for better readability
  • Repetitive command patterns - Simplified descriptions while maintaining clarity
  • Examples section - Removed as it duplicated information from command descriptions
  • Verbose Strict Mode explanation - Condensed while preserving all security details

Result

  • Before: 522 lines
  • After: 329 lines
  • Reduction: 37% (193 lines removed)

Technical Accuracy

✅ All command syntax preserved
✅ All options and flags documented
✅ All links and references maintained
✅ No functionality descriptions removed
✅ Security guidance preserved

Screenshot

Full-page screenshot of the cleaned CLI Commands documentation in Astro Starlight:

CLI Commands Documentation

Testing

  • ✅ Documentation builds successfully
  • ✅ All internal links functional
  • ✅ Navigation structure preserved
  • ✅ Markdown rendering correct

AI generated by Documentation Unbloat


Note

This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download patch artifact

The patch file is available as an artifact (aw.patch) in the workflow run linked above.
To apply the patch locally:

# Download the artifact from the workflow run https://github.com/githubnext/gh-aw/actions/runs/19617967406
# (Use GitHub MCP tools if gh CLI is not available)
gh run download 19617967406 -n aw.patch
# Apply the patch
git am aw.patch
Show patch preview (433 of 433 lines)
From 044351c1954e64f153e90992d63572acdee75019 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Sun, 23 Nov 2025 22:10:49 +0000
Subject: [PATCH] docs: remove bloat from CLI commands documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Cleaned up setup/cli.md by removing redundant and verbose content:
- Removed duplicate Quick Start section (already covered in Most Common Commands table)
- Consolidated verbose "What it does" bullet lists into concise prose
- Simplified options tables by converting to inline descriptions
- Reduced repetitive patterns across command descriptions
- Removed Examples section (duplicated information from commands)
- Condensed Strict Mode explanation while preserving essential security details

Result: 522 lines → 329 lines (37% reduction)

All technical accuracy and essential information preserved.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
---
 docs/src/content/docs/setup/cli.md | 240 +++--------------------------
 1 file changed, 24 insertions(+), 216 deletions(-)

diff --git a/docs/src/content/docs/setup/cli.md b/docs/src/content/docs/setup/cli.md
index 879a8f5..22b673d 100644
--- a/docs/src/content/docs/setup/cli.md
+++ b/docs/src/content/docs/setup/cli.md
@@ -25,29 +25,6 @@ Start here! These commands cover the essential workflow lifecycle from setup to
 
 **Complete command reference below** ↓
 
-## Quick Start
-
-Get started in seconds:
-
-```bash wrap
-gh aw init                                  # Initialize repository
-gh aw add githubnext/agentics/ci-doctor    # Add a workflow
-gh aw trial ci-doctor                       # Test safely
-```
-
-**Common Tasks:**
-
-| Task | Command |
-|------|---------|
-| Add workflow | `gh aw add githubnext/agentics/ci-doctor` |
-| Create custom workflow | `gh aw new my-workflow` |
-| Compile to YAML | `gh aw compile` |
-|
... (truncated)

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions