Skip to content

[docs] Remove bloat and fix formatting in AI Engines documentation#1812

Merged
pelikhan merged 2 commits intodocs-unbloat-engines-2025-10-16-dd29646b93555ab0from
copilot/stack-pr-1811
Oct 16, 2025
Merged

[docs] Remove bloat and fix formatting in AI Engines documentation#1812
pelikhan merged 2 commits intodocs-unbloat-engines-2025-10-16-dd29646b93555ab0from
copilot/stack-pr-1811

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 16, 2025

Documentation Cleanup: AI Engines Reference

This PR removes bloat from docs/src/content/docs/reference/engines.md while preserving all essential information and ensuring compliance with documentation style guidelines.

File Improved

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

Changes Made

1. Converted bold text to proper markdown headers

  • Replaced all bold text pseudo-headers with proper markdown level 4 headers (####)
  • **Extended configuration:**#### Extended Configuration
  • **Configuration options:**#### Configuration Options
  • **Environment Variables:**#### Environment Variables
  • **Required Secrets:**#### Required Secrets
  • **Codex-specific fields:**#### Codex-Specific Fields

This ensures compliance with documentation style guidelines: "Headings: Use markdown heading syntax, not bold text as headings"

2. Removed bloat while preserving content

  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 → 205 lines (19% reduction)
  • Secret command blocks: 5 → 3 (consolidated)
  • GITHUB_MCP_TOKEN sections: 4 mentions → 2 references (deduplicated)
  • Bold text headers: 14 → 0 (converted to proper markdown)

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 with proper markdown headers and improved conciseness:

AI Engines documentation page


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

AI generated by Documentation Unbloat


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Oct 16, 2025

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)
    • Triggering command: node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro preview (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Remove bloat from AI Engines documentation [docs] Remove bloat and fix formatting in AI Engines documentation Oct 16, 2025
Copilot AI requested a review from pelikhan October 16, 2025 16:13
@pelikhan pelikhan marked this pull request as ready for review October 16, 2025 17:12
@pelikhan pelikhan merged commit 1160c52 into docs-unbloat-engines-2025-10-16-dd29646b93555ab0 Oct 16, 2025
6 checks passed
@pelikhan pelikhan deleted the copilot/stack-pr-1811 branch October 16, 2025 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants