Skip to content

[docs] docs: reduce bloat in common-issues.md by 22%#27483

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-common-issues-a5fa73dda4e67949
Apr 21, 2026
Merged

[docs] docs: reduce bloat in common-issues.md by 22%#27483
pelikhan merged 1 commit intomainfrom
docs/unbloat-common-issues-a5fa73dda4e67949

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Reduces docs/src/content/docs/troubleshooting/common-issues.md from 742 → 577 lines (22% reduction, 165 lines removed), preserving all essential information.

What was removed

  • Engine timeout errors (5 separate subsections → 1 table + 1 YAML block): Each engine had its own #### Header, **Error:**, **Cause:**, **Fix:** pattern repeating the same structure. Claude and Codex had identical YAML fixes (tools.timeout: 600). The standalone ### Workflow Job Timed Out section also duplicated the same timeout-minutes example.
  • GHES error messages (6 verbose bold-heading paragraphs → 1 table): 6 error messages each with a paragraph explanation are now a compact 6-row table with Cause and Fix columns.
  • Playwright require() example (20-line JS block → 4 lines): The ❌ INCORRECT / ✅ CORRECT block had unnecessary browser_run_code boilerplate. Replaced with a minimal 2-line example.
  • Duplicate debugging sections (### Why Did My Workflow Fail? + ### How Do I Debug a Failing Workflow? → merged): Two sections saying the same thing (use gh aw audit, ask an agent) merged into one.
  • Debugging Strategies section (standalone 1-liner → merged into Enable Debug Logging header).
  • Integrity Filtering section (Symptoms/Cause/Solution → 2 concise paragraphs).

What was preserved

All technical content: error message text, YAML configs, links to other docs, the engine: / max-turns: / max-continuations: settings, and the gh aw commands used for debugging.

Screenshots

Playwright container could not reach the agent container's bridge IP (172.30.0.20) — network isolation prevented browser screenshots. The docs server was confirmed to serve the page correctly via curl (HTTP 200, correct page title "Common Issues | GitHub Agentic Workflows").

Blocked Domains

No blocked domains encountered (screenshots skipped due to network isolation, not domain blocking).

References:

🗜️ Compressed by Documentation Unbloat · ● 709.1K ·

  • expires on Apr 23, 2026, 4:01 AM UTC

Consolidate repetitive troubleshooting patterns into tables and compact
prose. Engine timeout errors were 5 separate subsections with identical
structure; replaced with a quick-reference table and a single YAML block.
GHES error messages were 6 verbose paragraphs; replaced with a table.
Merged duplicate debugging sections and trimmed Playwright example.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation doc-unbloat documentation Improvements or additions to documentation labels Apr 21, 2026
@pelikhan pelikhan marked this pull request as ready for review April 21, 2026 04:36
Copilot AI review requested due to automatic review settings April 21, 2026 04:36
@pelikhan pelikhan merged commit 73f9856 into main Apr 21, 2026
3 checks passed
@pelikhan pelikhan deleted the docs/unbloat-common-issues-a5fa73dda4e67949 branch April 21, 2026 04:37
Copy link
Copy Markdown
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 streamlines common-issues.md by removing repetitive troubleshooting prose while preserving the key fixes and references, primarily by replacing long-form sections with compact tables and shorter examples.

Changes:

  • Simplified the Playwright “Cannot find module 'playwright'” guidance to a minimal MCP-tools example.
  • Converted verbose GHES Copilot error explanations into a concise “Error / Cause / Fix” table and removed duplicated guidance.
  • Consolidated timeout/debugging guidance (including per-engine timeout knobs) into a single “Timeout Errors” section with a mapping table and a unified config example.
Show a summary per file
File Description
docs/src/content/docs/troubleshooting/common-issues.md Removes duplicated troubleshooting text and replaces it with tables/minimal examples for GHES errors, timeouts, Playwright usage, and integrity filtering guidance.

Copilot's findings

Tip

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

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

This was referenced Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation doc-unbloat documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants