[docs] Remove bloat from AI Engines documentation#1811
Merged
Conversation
Improved clarity and conciseness in docs/src/content/docs/reference/engines.md: - Consolidated duplicate secret setup instructions (5 → 3 code blocks) - Unified GITHUB_MCP_TOKEN documentation (removed 2 duplicate sections) - Condensed configuration option descriptions - Simplified command-line arguments section (removed redundant examples) - Streamlined migration section (removed repetitive examples) - Reduced Custom Engine verbose feature list to single line Changes preserve all essential information while improving readability. Line count: 252 → 194 lines (23% reduction) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Collaborator
|
@copilot use markdown headers |
Contributor
Contributor
Author
|
Agentic Changeset Generator triggered by this pull request |
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.
Documentation Cleanup: AI Engines Reference
This PR removes bloat from
docs/src/content/docs/reference/engines.mdwhile preserving all essential information.File Improved
Types of Bloat Removed
Duplicate secret setup instructions
gh secret setcommand blocks into 3 concise blocksRedundant GITHUB_MCP_TOKEN documentation
Verbose configuration descriptions
Excessive command-line arguments section
Repetitive migration examples
Verbose Custom Engine section
Metrics
Content Preserved
✅ All technical accuracy and specific details
✅ All code examples (consolidated duplicates)
✅ All links to external resources
✅ All critical warnings and notes
✅ All frontmatter metadata
✅ All configuration options and fields
Screenshot
The rendered documentation page maintains full clarity with improved conciseness:
Blocked Domains
✅ No blocked CSS, font, or resource domains detected during screenshot capture.
Cache Updated: Added to
/tmp/gh-aw/cache-memory/cleaned-files.txtto avoid duplicate cleanup in future runs.