Skip to content

[docs] Remove bloat from AI Engines documentation#1811

Merged
pelikhan merged 2 commits intomainfrom
docs-unbloat-engines-2025-10-16-dd29646b93555ab0
Oct 16, 2025
Merged

[docs] Remove bloat from AI Engines documentation#1811
pelikhan merged 2 commits intomainfrom
docs-unbloat-engines-2025-10-16-dd29646b93555ab0

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Cleanup: AI Engines Reference

This PR removes bloat from docs/src/content/docs/reference/engines.md while preserving all essential information.

File Improved

  • docs/src/content/docs/reference/engines.md

Types of Bloat Removed

  1. Duplicate secret setup instructions

    • Consolidated 5 repetitive gh secret set command blocks into 3 concise blocks
    • Unified all secrets under clear "Required Secrets" sections with both commands shown together
  2. Redundant GITHUB_MCP_TOKEN documentation

    • Removed 2 duplicate sections explaining the same concept
    • Consolidated into single line references to GitHub Tools Remote Mode
  3. Verbose configuration descriptions

    • Changed "Copilot-specific fields" from 3 verbose bullet points to concise descriptions
    • Removed unnecessary "(optional)" repetition from field descriptions
    • Streamlined inline comments in code examples
  4. Excessive command-line arguments section

    • Removed redundant example showing the CLI command structure
    • Condensed "Common use cases" and "Important notes" bullet lists into flowing prose
    • Eliminated repetitive "Example with multiple arguments" section
  5. Repetitive migration examples

    • Reduced migration section from 3 different examples to 2 clear examples
    • Removed redundant comments showing "Old" and "New" engine values
  6. Verbose Custom Engine section

    • Reduced 3-bullet feature list to single descriptive sentence
    • Maintained all technical information in more concise format

Metrics

  • Line count: 252 → 194 lines (23% reduction)
  • Secret command blocks: 5 → 3 (consolidated)
  • GITHUB_MCP_TOKEN sections: 4 mentions → 2 references (deduplicated)

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:

AI Engines Documentation

Blocked Domains

✅ No blocked CSS, font, or resource domains detected during screenshot capture.


Cache Updated: Added to /tmp/gh-aw/cache-memory/cleaned-files.txt to avoid duplicate cleanup in future runs.

AI generated by Documentation Unbloat

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>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Oct 16, 2025
@pelikhan
Copy link
Copy Markdown
Collaborator

@copilot use markdown headers

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 16, 2025

@pelikhan I've opened a new pull request, #1812, to work on those changes. Once the pull request is ready, I'll request review from you.

@pelikhan pelikhan marked this pull request as ready for review October 16, 2025 17:14
@github-actions
Copy link
Copy Markdown
Contributor Author

Agentic Changeset Generator triggered by this pull request

@pelikhan pelikhan merged commit 96688e6 into main Oct 16, 2025
20 checks passed
@pelikhan pelikhan deleted the docs-unbloat-engines-2025-10-16-dd29646b93555ab0 branch October 16, 2025 17:15
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.

2 participants