[docs] docs: Remove bloat from permissions.md#3575
Conversation
Condensed documentation while preserving all essential information: - Consolidated large permission scopes table into concise prose - Merged repetitive configuration sections into shorthand options - Unified common patterns section with inline examples - Streamlined safe outputs and validation sections Result: 206 → 98 lines (52% reduction) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
|
@copilot the examples should not use "write" at all. It is not recommended. |
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines the permissions documentation by removing redundant content and consolidating repetitive sections while preserving all essential technical information. The changes reduce the file from 206 to 98 lines (52% reduction) by replacing verbose tables and repeated examples with concise prose and unified code blocks.
Key changes:
- Replaced the 13-row permission scopes table with a concise prose summary
- Consolidated four separate workflow examples into a single annotated code block
- Merged three configuration subsections (read-all, write-all, no permissions) into a bullet list
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/content/docs/reference/permissions.md | Streamlined permissions documentation by removing verbose tables, consolidating workflow examples, and converting repetitive sections to concise prose |
| .github/workflows/schema-consistency-checker.lock.yml | Updated code reference comments to reflect refactored network-related workflow files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| create-issue: | ||
| add-comment: |
There was a problem hiding this comment.
The safe-outputs configuration in the example is incomplete. Each safe output should include a max limit (e.g., max: 5) to demonstrate proper rate limiting configuration, consistent with the examples shown later in the document.
| create-issue: | |
| add-comment: | |
| create-issue: | |
| max: 5 | |
| add-comment: | |
| max: 5 |
| - **Read-only by default**: Main job runs with minimal read permissions only | ||
| - **Write through safe outputs**: Write operations happen in separate jobs with sanitized content | ||
| - **Explicit permissions**: All permissions must be declared in frontmatter | ||
| - **No direct write permissions**: Use safe-outputs instead of `write` permissions in the main job |
There was a problem hiding this comment.
Corrected 'safe-outputs' to 'safe outputs' for consistency with the rest of the document, which uses the unhyphenated form when referring to the feature in prose (vs. safe-outputs: in YAML configuration).
| - **No direct write permissions**: Use safe-outputs instead of `write` permissions in the main job | |
| - **No direct write permissions**: Use safe outputs instead of `write` permissions in the main job |
Documentation Unbloat: permissions.md
This PR removes documentation bloat from
docs/src/content/docs/reference/permissions.mdwhile preserving all essential information.Changes Made
File improved:
reference/permissions.mdBloat removed:
Metrics
Screenshot
Preview of the improved documentation page:
Verification
The documentation remains complete and accurate:
Part of the ongoing documentation unbloat effort to improve readability and reduce redundancy across all docs.