Skip to content

Conversation

@github-actions
Copy link
Contributor

Documentation Unbloat: permissions.md

This PR removes documentation bloat from docs/src/content/docs/reference/permissions.md while preserving all essential information.

Changes Made

File improved: reference/permissions.md

Bloat removed:

  1. Large permission scopes table (lines 33-45): Replaced 13-row table with concise prose listing key permissions
  2. Verbose configuration sections (lines 60-91): Condensed three separate sections (read-all, write-all, no permissions) into a single bullet list
  3. Repetitive common patterns (lines 92-156): Unified four separate workflow examples with repeated structure into a single consolidated code block with inline comments
  4. Excessive safe outputs section (lines 157-177): Streamlined from detailed explanation with bullet points to concise single paragraph
  5. Wordy validation section (lines 179-199): Reduced verbose explanation to essential command and key points

Metrics

  • Line reduction: 206 → 98 lines (52% reduction)
  • Structure improvements:
    • Removed 1 large table (10 rows)
    • Consolidated 4 separate workflow examples into 1 unified block
    • Merged 3 configuration subsections into 1 bullet list
  • Content preserved: All technical details, links, and essential information retained

Screenshot

Preview of the improved documentation page:

Permissions Documentation

Verification

The documentation remains complete and accurate:

  • All permission types still documented
  • All configuration options preserved
  • All common patterns shown (just consolidated)
  • All related links maintained
  • Technical accuracy unchanged

Part of the ongoing documentation unbloat effort to improve readability and reduce redundancy across all docs.

AI generated by Documentation Unbloat

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>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Nov 10, 2025
@pelikhan
Copy link
Contributor

@copilot the examples should not use "write" at all. It is not recommended.

Copy link
Contributor

Copilot AI commented Nov 10, 2025

@pelikhan I've opened a new pull request, #3576, to work on those changes. Once the pull request is ready, I'll request review from you.

@pelikhan pelikhan marked this pull request as ready for review November 11, 2025 01:09
Copilot AI review requested due to automatic review settings November 11, 2025 01:09
@pelikhan pelikhan merged commit 837cf5f into main Nov 11, 2025
10 checks passed
@pelikhan pelikhan deleted the docs/unbloat-permissions-07a13c3cab7546f7 branch November 11, 2025 01:09
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

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.

Comment on lines +15 to +16
create-issue:
add-comment:
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

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.

Suggested change
create-issue:
add-comment:
create-issue:
max: 5
add-comment:
max: 5

Copilot uses AI. Check for mistakes.
- **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
Copy link

Copilot AI Nov 11, 2025

Choose a reason for hiding this comment

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

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).

Suggested change
- **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

Copilot uses AI. Check for mistakes.
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