Skip to content

[docs] docs: reduce bloat in footers.md (-22%)#20737

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-footers-6798128956d07fc1
Mar 13, 2026
Merged

[docs] docs: reduce bloat in footers.md (-22%)#20737
pelikhan merged 1 commit intomainfrom
docs/unbloat-footers-6798128956d07fc1

Conversation

@github-actions
Copy link
Contributor

Reduces docs/src/content/docs/reference/footers.md from 186 to 145 lines — a 41-line (22%) reduction while preserving all essential content.

Changes Made

File improved: docs/src/content/docs/reference/footers.md

Bloat removed:

  1. Condensed "When footer: false is set" bullet list → prose (saved ~3 lines)

    • Three verbose bullets converted to a single concise sentence
  2. Removed duplicate code block and condensed PR review values (saved ~20 lines)

    • The "Example use case - Clean approvals" section contained a code block nearly identical to the example shown just above it
    • The 3-value string list + 2-value boolean list (7 bullet points across two lists) replaced with a single concise sentence
  3. Condensed "What's Preserved" numbered list (saved ~8 lines)

    • Two numbered items with HTML code blocks replaced with compact inline bullet format
  4. Condensed TIP block (saved ~5 lines)

    • Five bullet points in the search tips tip reduced to a single sentence with the essential information
  5. Removed redundant "When to use each approach" bullets (saved ~3 lines)

    • Two bullets that restated the headings of surrounding sections removed

Preserved content

  • All search query examples
  • All configuration options and their explanations
  • All use case code blocks
  • All links to related documentation
  • Backward compatibility note

Screenshots

Screenshots could not be captured in this run due to network restrictions preventing the Playwright browser from connecting to the local preview server (172.30.0.20:4322).

References:

🗜️ Compressed by Documentation Unbloat ·

  • expires on Mar 15, 2026, 12:30 AM UTC

Remove duplicate code block, condense verbose bullet lists to prose,
and simplify the TIP block. Reduces file from 186 to 145 lines (~22%)
while preserving all essential content.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 13, 2026
@pelikhan pelikhan marked this pull request as ready for review March 13, 2026 01:29
Copilot AI review requested due to automatic review settings March 13, 2026 01:29
@pelikhan pelikhan merged commit ae5b14f into main Mar 13, 2026
@pelikhan pelikhan deleted the docs/unbloat-footers-6798128956d07fc1 branch March 13, 2026 01:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the “Footer Control” documentation to be more concise by collapsing several bulleted explanations into shorter prose while preserving the same guidance on footer suppression, conditional review footers, and marker-based search.

Changes:

  • Condensed the global footer: false explanation into a single paragraph.
  • Simplified the PR review footer control section into a compact description of supported values and behavior.
  • Streamlined the “preserved markers” and search tips sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

- **Visible footer content is omitted** - No AI-generated attribution text appears in the item body
- **XML markers are preserved** - Hidden workflow-id and tracker-id markers remain for searchability
- **All safe output types affected** - Applies to create-issue, create-pull-request, create-discussion, update-issue, update-pull-request, update-discussion, and update-release
When `footer: false` is set, visible attribution text is omitted from item bodies but hidden XML markers (workflow-id, tracker-id) remain for searchability. Applies to all output types: create-issue, create-pull-request, create-discussion, update-issue, update-pull-request, update-discussion, and update-release.
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