Skip to content

[docs] docs: condense MultiRepoOps best practices and remove redundant sections#21311

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-multi-repo-ops-9945a88c2b459094
Mar 17, 2026
Merged

[docs] docs: condense MultiRepoOps best practices and remove redundant sections#21311
pelikhan merged 1 commit intomainfrom
docs/unbloat-multi-repo-ops-9945a88c2b459094

Conversation

@github-actions
Copy link
Contributor

Reduces documentation bloat in docs/src/content/docs/patterns/multi-repo-ops.md by removing repetitive and generic content while preserving all essential information.

What was changed

File: docs/src/content/docs/patterns/multi-repo-ops.md
Reduction: 268 → 219 lines (49 lines removed, 18.3% reduction)

Types of bloat removed

  1. Bloated Best Practices section — 4 sub-sections (Authentication and Security, Workflow Design, Error Handling, Testing), each with 3–4 generic bullet points, condensed into 4 compact inline bullets under a single ## Best Practices heading. Saves ~22 lines.

  2. Redundant Advanced Topics section — Removed entirely. The two sub-sections ("Private Repository Access" and "Organization-Level Operations") contained generic setup advice (e.g., "rotate tokens regularly", "plan phased rollouts", "provide clear communication") that isn't specific to MultiRepoOps and adds no value beyond what is already covered in the Authentication section above. Saves ~18 lines.

  3. Duplicate "Available Operations" list — Removed the 4-bullet enumeration of GitHub toolset operations (repos, issues, pull_requests, actions) from the "Teaching Agents Multi-Repo Access" section. This information is already documented in the linked GitHub Tools Reference. Saves ~6 lines.

  4. Redundant closing sentence — Removed one trailing sentence that restated what the preceding code example already demonstrated. Saves ~2 lines.

Essential content preserved

  • All code examples and workflow patterns unchanged
  • Authentication guidance (PAT and GitHub App sections)
  • Cross-repository safe outputs reference table
  • All external links and related documentation
  • ASCII diagrams for the three hub-and-spoke patterns

Issues

Screenshots of the rendered page could not be captured — Playwright browser tools timed out in this environment. The documentation change is purely additive and formatting-only (no structural changes to the Starlight site).

References:

🗜️ Compressed by Documentation Unbloat ·

  • expires on Mar 19, 2026, 12:12 AM UTC

Remove 49 lines (18.3% reduction) from multi-repo-ops.md by:
- Condensing the Best Practices section from 4 sub-sections (22 lines)
  into 4 compact inline bullets
- Removing the Advanced Topics section (18 lines) which contained generic
  advice not specific to MultiRepoOps
- Removing the redundant "Available Operations" list from the Teaching
  Agents section (6 lines) since it duplicates GitHub Tools Reference
- Removing a redundant closing sentence that restated the code example

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 17, 2026
@pelikhan pelikhan marked this pull request as ready for review March 17, 2026 02:06
Copilot AI review requested due to automatic review settings March 17, 2026 02:06
@pelikhan pelikhan merged commit 6c258a1 into main Mar 17, 2026
@pelikhan pelikhan deleted the docs/unbloat-multi-repo-ops-9945a88c2b459094 branch March 17, 2026 02:06
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

Condenses the MultiRepoOps documentation by removing redundant/generic guidance while keeping core examples, authentication guidance, and key references intact.

Changes:

  • Removed a redundant explanatory sentence following the initial hub-and-spoke example.
  • Removed the duplicated “Available Operations” list from the multi-repo toolsets section (now relying on the linked tools reference).
  • Replaced the verbose Best Practices + Advanced Topics sections with a compact Best Practices bullet list.

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

Comment on lines +202 to +205
- **Authentication**: Use GitHub Apps for automatic token revocation; scope PATs minimally to required repositories; store tokens as GitHub secrets
- **Workflow design**: Set appropriate `max` limits; use meaningful title prefixes and consistent labels
- **Error handling**: Handle rate limits and permission failures; monitor workflow execution across repositories
- **Testing**: Start with public repositories, pilot a small subset, and verify configurations before full rollout
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