[docs] Unbloat common-issues.md troubleshooting documentation#16474
[docs] Unbloat common-issues.md troubleshooting documentation#16474
Conversation
Reduced bloat by consolidating verbose explanations and eliminating redundant information while preserving all essential technical content. Changes: - Condensed installation instructions (removed 3 subsections) - Simplified repository configuration explanations - Consolidated compilation issue descriptions - Reduced import/include issue verbosity - Streamlined tool configuration guidance - Condensed Playwright error explanations - Simplified permission and token guidance - Reduced GitHub lockdown mode explanation - Streamlined debugging section Result: 60 fewer lines (~13% reduction) with no loss of critical information. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This pull request reduces documentation bloat in the troubleshooting common-issues guide by condensing verbose explanations while preserving all essential technical content. The changes successfully reduce the file from 468 to 407 lines (13% reduction, ~35% word count reduction) through consolidation of subsections, elimination of redundant bullet points, and streamlining of multi-paragraph explanations into concise guidance.
Changes:
- Consolidated installation issues from 4 subsections into 1 unified section
- Simplified repository configuration descriptions from verbose paragraphs to numbered lists
- Streamlined tool configuration, Playwright errors, permission issues, and network sections by removing redundant examples and verbose explanations
- Condensed GitHub lockdown mode section from detailed long-form content to focused guidance
- Reduced debugging section to essential strategies without repetitive formatting
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Problem**: GitHub Projects reserves field types like `REPOSITORY` that cannot be updated via API. | ||
|
|
||
| **Solution**: Use alternative field names (`repo`, `source_repository`, `linked_repo`) instead of `repository`: | ||
| GitHub Projects reserves field names like `REPOSITORY`. Use alternatives (`repo`, `source_repository`, `linked_repo`): |
There was a problem hiding this comment.
The condensed text is less clear about the actual issue. The original stated "GitHub Projects reserves field types like REPOSITORY that cannot be updated via API" and suggested using alternative "field names" instead of "repository". The condensed version says "reserves field names like REPOSITORY" but the code example shows lowercase "repository" as wrong. Consider: "GitHub Projects reserves the field name repository (uses REPOSITORY type). Use alternatives (repo, source_repository, linked_repo):" to better connect the explanation to the code example.
| GitHub Projects reserves field names like `REPOSITORY`. Use alternatives (`repo`, `source_repository`, `linked_repo`): | |
| GitHub Projects reserves the field name `repository` (it uses the `REPOSITORY` field type). Use alternatives (`repo`, `source_repository`, `linked_repo`): |
Summary
Reduced documentation bloat in
troubleshooting/common-issues.mdby consolidating verbose explanations and eliminating redundant information while preserving all essential technical content.Changes Made
Impact
Types of Bloat Removed
require('playwright')or created a standalone Node.js script expecting..." → "The agent tried torequire('playwright')but..."Screenshot Issues
localhost:4321or the host IP address.Blocked Domains: None - the issue is container-to-host networking, not domain blocking.
Verification
File before: 468 lines
File after: 407 lines
Reduction: 60 lines (13%)
Git diff stats: