[docs] docs: reduce bloat in common-issues.md by 22%#27483
Merged
Conversation
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>
pelikhan
approved these changes
Apr 21, 2026
Contributor
There was a problem hiding this comment.
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
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reduces
docs/src/content/docs/troubleshooting/common-issues.mdfrom 742 → 577 lines (22% reduction, 165 lines removed), preserving all essential information.What was removed
#### Header,**Error:**,**Cause:**,**Fix:**pattern repeating the same structure. Claude and Codex had identical YAML fixes (tools.timeout: 600). The standalone### Workflow Job Timed Outsection also duplicated the sametimeout-minutesexample.require()example (20-line JS block → 4 lines): The❌ INCORRECT/✅ CORRECTblock had unnecessarybrowser_run_codeboilerplate. Replaced with a minimal 2-line example.### Why Did My Workflow Fail?+### How Do I Debug a Failing Workflow?→ merged): Two sections saying the same thing (usegh aw audit, ask an agent) merged into one.What was preserved
All technical content: error message text, YAML configs, links to other docs, the
engine:/max-turns:/max-continuations:settings, and thegh awcommands used for debugging.Screenshots
Blocked Domains
No blocked domains encountered (screenshots skipped due to network isolation, not domain blocking).
References: