Skip to content

[docs] docs: unbloat trial-ops.md (24% reduction)#19478

Merged
pelikhan merged 2 commits intomainfrom
docs/unbloat-trial-ops-8f13493af556443c
Mar 4, 2026
Merged

[docs] docs: unbloat trial-ops.md (24% reduction)#19478
pelikhan merged 2 commits intomainfrom
docs/unbloat-trial-ops-8f13493af556443c

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Mar 4, 2026

Reduces docs/src/content/docs/patterns/trial-ops.md from 294 to 223 lines (71 lines removed, 24% reduction) while preserving all essential information.

What was improved

File: docs/src/content/docs/patterns/trial-ops.md

Change Before After
Intro section NOTE callout + 2 redundant paragraphs saying the same thing Single concise opening sentence
How Trial Mode Works Command + 3-bullet output list Command + single prose sentence
Repository Modes 4 sub-sections with text + code (~35 lines) Compact table with WARNING callout (~10 lines)
Dry-Run Mode Command + 2-sentence verbose explanation Command + 1-line description
Comparing Multiple Workflows Redundant standalone command + "Example:" repeat Single introductory sentence + combined example
Development Workflow 7-step numbered list Single prose sentence
Common Trial Patterns 4 named patterns with full commands (~22 lines) Removed (duplicated flag combinations already shown throughout)

Types of bloat removed

  • Duplicate content: The intro NOTE callout repeated the same information as the two paragraphs below it
  • Redundant structure: "Common Trial Patterns" was entirely composed of flag combinations already demonstrated in earlier sections
  • Excessive bullet points: Repository Modes used 4 sub-sections where a table is more scannable
  • Verbose descriptions: Dry-Run Mode explanation restated what --dry-run already implies
  • Over-engineered lists: The 7-step Development Workflow list was replaced with an equivalent prose sentence

Issues

Screenshots: The sandbox network firewall prevented Playwright from connecting to the local preview server (net::ERR_CONNECTION_REFUSED on both localhost:4321 and 172.30.0.20:4321). Screenshots could not be captured. The documentation build completed successfully (127 page(s) built in 32.46s, all internal links valid).

References:

🗜️ Compressed by Documentation Unbloat ·

  • expires on Mar 6, 2026, 12:27 AM UTC


✨ PR Review Safe Output Test - Run 22649894679

💥 [THE END] — Illustrated by Smoke Claude ·

Reduce trial-ops.md from 294 to 223 lines (24% reduction) by:
- Merging redundant NOTE callout and intro paragraphs into one concise opener
- Converting Repository Modes sub-sections into a compact table
- Removing verbose Dry-Run Mode explanation
- Condensing How Trial Mode Works bullet list to a single sentence
- Condensing Comparing Multiple Workflows to remove the duplicate standalone example
- Condensing Development Workflow 7-step list to a single prose sentence
- Removing the Common Trial Patterns section (duplicated flag combinations shown earlier)

All essential technical information is preserved.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 4, 2026
@pelikhan pelikhan marked this pull request as ready for review March 4, 2026 03:15
Copilot AI review requested due to automatic review settings March 4, 2026 03:15
@pelikhan pelikhan merged commit f7b63b9 into main Mar 4, 2026
2 checks passed
@pelikhan pelikhan deleted the docs/unbloat-trial-ops-8f13493af556443c branch March 4, 2026 03:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reduces docs/src/content/docs/patterns/trial-ops.md by ~24% (294 → 224 lines) by eliminating redundant content, consolidating verbose sections into prose or tables, and removing a "Common Trial Patterns" section whose examples were already covered elsewhere in the document.

Changes:

  • Replaced the NOTE callout + 2 redundant intro paragraphs with a single concise opening sentence
  • Converted 4 "Repository Modes" subsections into a compact table with a targeted WARNING callout
  • Removed the "Common Trial Patterns" section (7 duplicate flag examples already shown in earlier sections), the 7-step "Development Workflow" numbered list (replaced with a prose sentence), and extraneous verbose descriptions throughout

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines 212 to 217
| `execution timed out` | Increase with `--timeout 60` (minutes, default: 30) |
| No issues/PRs created | Configure `safe-outputs` in workflow frontmatter, check Actions logs for errors |

## Common Trial Patterns

**Pre-deployment validation:**
```bash
gh aw trial ./new-feature.md --clone-repo myorg/production-repo --host-repo pre-deployment-test
```

**Prompt optimization:**
```bash
gh aw trial ./workflow-detailed.md ./workflow-concise.md
cat trials/combined-results.*.json | jq
```

**Documentation examples:**
```bash
gh aw trial ./workflow.md --force-delete-host-repo-before --host-repo workflow-demo
```

**Debugging production issues:**
```bash
gh aw trial ./workflow.md --clone-repo myorg/production --trigger-context "https://github.com/myorg/production/issues/456" --host-repo debug-session
```

## Related Documentation

- [SideRepoOps](/gh-aw/patterns/side-repo-ops/) - Run workflows from separate repositories
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description states the file was reduced to 223 lines, but the actual file has 224 lines. This is a minor discrepancy between the stated and actual result.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants