Skip to content

[docs] Remove bloat from integrity filtering reference#25977

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
docs/unbloat-integrity-d9b5195c2acd9ad5
Closed

[docs] Remove bloat from integrity filtering reference#25977
github-actions[bot] wants to merge 1 commit intomainfrom
docs/unbloat-integrity-d9b5195c2acd9ad5

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Reduces docs/src/content/docs/reference/integrity.md from 398 → 318 lines (80 lines, 20.1% reduction) while preserving all essential information.

What was removed

Verbose level descriptions — The five integrity-level descriptions (merged, approved, unapproved, none, blocked) each contained paragraph-length text that repeated information already in the table above and the "Choosing a Level" section below. Condensed to single-sentence summaries that retain the technically unique details (e.g., private-repo elevation, bot trust, CONTRIBUTOR classification).

6 redundant Examples — The Examples section contained 11 examples; 6 were identical to examples already shown inline in their respective subsections:

  • "Scope to specific organizations" → duplicate of Scoping section
  • "Block specific users" → duplicate of Blocking subsection
  • "Trust specific external contributors" → duplicate of Trusting subsection
  • "Human-review gate" → duplicate of Promotion subsection
  • "Centrally managed lists" → duplicate of GitHub Variables subsection
  • "Disable the pre-agent integrity proxy" → duplicate of Disabling proxy subsection

Kept the "Combined: blocking, trusting, and labeling" example (unique) plus the four single-field examples.

Prose tightening — Removed trailing sentences that restated what was just said ("This mechanism allows a security team to...", "This is useful when a workflow's min-integrity would normally filter out..."), condensed the proxy bullet list to prose, simplified the Default Behavior section, and removed the intro sentence from Choosing a Level.

Estimated reduction

Metric Before After Change
Lines 398 318 −80 (20.1%)
Words 2,281 ~1,860 −~420 (18.4%)

Screenshots

Visual screenshots were unavailable due to network isolation between the Playwright container and the agent container (net::ERR_CONNECTION_TIMED_OUT). The page was verified to render correctly via curl — HTTP 200, all 13 section headings confirmed present (How It Works, Configuration, Configuration Reference, Integrity Levels, Scoping to Repositories, Adjusting Integrity Per-Item, Centralized Management via GitHub Variables, Default Behavior, Pre-Agent Integrity Proxy, Choosing a Level, Examples, In Logs and Reports, Related Documentation).

Blocked domains: Not applicable (screenshots not captured).

References: §24324801347

🗜️ Compressed by Documentation Unbloat · ● 682K ·

  • expires on Apr 15, 2026, 4:05 AM UTC

Condense level descriptions, remove 6 redundant examples already shown
in subsections, and tighten prose throughout. 398 → 318 lines (20.1%).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Apr 13, 2026
@pelikhan pelikhan closed this Apr 13, 2026
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.

1 participant