[docs] docs: remove bloat from network.md reference#18415
Merged
Conversation
Reduce redundancy and improve scannability: - Condense Configuration section from 6 YAML examples to 2, adding cross-links to dedicated sections (blocking, protocol filtering, wildcards) already present in the page - Remove SSL bump "Configuration Options" bullet list that restated YAML code comments, and duplicate "Usage Example with Log Level" block already covered by the Firewall Log Level section - Convert verbose wildcard matching-behavior bullet list into concise inline prose (~65 lines removed, ~18% reduction) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
This was referenced Feb 26, 2026
pelikhan
approved these changes
Feb 26, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the Network Permissions reference documentation by removing repetitive examples and restated explanations while preserving the key guidance via cross-links and consolidated prose.
Changes:
- Reduced the opening Configuration section to two canonical examples and added links to detailed sections.
- Removed duplicated/redundant SSL bump “configuration options” prose and an overlapping example.
- Condensed wildcard matching behavior from a verbose bullet list into a single explanatory paragraph.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Removes redundant content from
docs/src/content/docs/reference/network.mdto improve scannability without losing any information.What was improved
File:
docs/src/content/docs/reference/network.mdBefore: 358 lines | After: 293 lines | Reduction: 65 lines (~18%)
Types of bloat removed
Redundant Configuration examples — The opening
## Configurationsection contained 6 YAML code blocks demonstrating all feature combinations (basic, ecosystems, wildcards, protocol-specific, blocking, ecosystem-blocking). Each of these patterns already has its own dedicated section with explanation later in the file. Reduced to 2 canonical examples with cross-links to the dedicated sections.Restated code comments — The SSL Bump section had a "Configuration Options" bullet list that exactly restated the inline YAML comments (
ssl-bump,allow-urls) already visible in the adjacent code block. Removed.Duplicate SSL bump example — A "Usage Example with Log Level" code block in the SSL Bump section duplicated a nearly identical example already shown in the
### Firewall Log Levelsection immediately above. Removed.Verbose wildcard bullets — The
## Wildcard Domain Patternssection had a 4-bullet list describing matching behavior, most of which was self-evident from the code comments or already stated in the preceding Access Levels section. Condensed into a single prose sentence.Screenshot capture
Screenshot capture was attempted but Playwright could not reach the local preview server (
172.30.0.20:4321) due to network isolation in the sandbox environment. The server was confirmed running viacurland all content renders successfully.References: §22421510663