Skip to content

[docs] docs: unbloat SideRepoOps page #19906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Mar 7, 2026
Merged

[docs] docs: unbloat SideRepoOps page #19906

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb83aa7
docs: unbloat SideRepoOps page - condense bullets into prose
Mar 7, 2026
7c73a91
ci: trigger checks
github-actions[bot] Mar 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 4 additions & 24 deletions docs/src/content/docs/patterns/side-repo-ops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,7 @@ SideRepoOps is a development pattern where you run agentic workflows from a sepa

## When to Use SideRepoOps

**Getting Started**: SideRepoOps is ideal when you're new to agentic workflows and want a low-risk way to experiment. You can test automation without adding files to your main repository or worrying about breaking existing workflows.

**Key Benefits**:
- **Zero friction** - No changes needed to your main repository
- **Clean separation** - AI-generated issues stay separate from organic development
- **Private workflows** - Store sensitive automation logic in a private repository
- **Safe experimentation** - Perfect for testing and learning before production deployment
- **Centralized automation** - Manage workflows for repositories you don't directly control

Use SideRepoOps for workflow experimentation, creating a centralized automation hub, or managing automation for multiple repositories.
SideRepoOps is ideal when you're new to agentic workflows and want a low-risk way to experiment — no changes needed to your main repository, AI-generated issues stay separate from organic development, and sensitive automation logic remains in a private repository. Use it for workflow experimentation, centralized automation across multiple repositories, or managing workflows for repositories you don't directly control.
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The clause after the em dash reads as a sentence fragment ("— no changes needed…"). Consider rephrasing to a full clause (e.g., "…and requires no changes to your main repository…") to keep the paragraph grammatically consistent and easier to scan.

Suggested change
SideRepoOps is ideal when you're new to agentic workflows and want a low-risk way to experiment — no changes needed to your main repository, AI-generated issues stay separate from organic development, and sensitive automation logic remains in a private repository. Use it for workflow experimentation, centralized automation across multiple repositories, or managing workflows for repositories you don't directly control.
SideRepoOps is ideal when you're new to agentic workflows and want a low-risk way to experiment, as it requires no changes to your main repository, keeps AI-generated issues separate from organic development, and ensures that sensitive automation logic remains in a private repository. Use it for workflow experimentation, centralized automation across multiple repositories, or managing workflows for repositories you don't directly control.

Copilot uses AI. Check for mistakes.

## How It Differs from MultiRepoOps

Expand All @@ -44,8 +35,6 @@ While [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) runs workflows **from** yo
└─────────────────┘ └──────────────────┘
```

In SideRepoOps, workflows run in GitHub Actions **on the side repository** but perform operations (create issues, PRs, comments) **on the main repository** using cross-repository authentication.

> [!TIP]
> Testing with TrialOps
> Before deploying SideRepoOps workflows to production, use [TrialOps](/gh-aw/patterns/trial-ops/) to test them in isolated trial repositories. This lets you validate behavior and iterate on prompts without creating real issues in your repositories.
Expand Down Expand Up @@ -392,17 +381,8 @@ safe-outputs:

This creates a feedback loop where the side repository tracks automation effectiveness.

## Related Patterns

- **[MultiRepoOps](/gh-aw/patterns/multi-repo-ops/)** - Coordinate work across multiple repositories from main repo
- **[Orchestration](/gh-aw/patterns/orchestration/)** - Orchestrate multi-issue initiatives
- **[IssueOps](/gh-aw/patterns/issue-ops/)** - Issue-driven automation patterns
## Related
Copy link
Contributor Author

@github-actions github-actions bot Mar 7, 2026

Choose a reason for hiding this comment

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

Combining "Related Patterns" and "Related Documentation" into a single "Related" section with dot-separated inline links is a clean improvement. This saves vertical space while maintaining discoverability.


## Related Documentation
**Patterns**: [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) · [Orchestration](/gh-aw/patterns/orchestration/) · [IssueOps](/gh-aw/patterns/issue-ops/)

- [Cross-Repository Operations](/gh-aw/reference/cross-repository/) - Checkout and target-repo configuration
- [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Complete safe output configuration
- [GitHub Tools](/gh-aw/reference/github-tools/) - GitHub API toolsets
- [Authentication](/gh-aw/reference/auth/) - Token types and precedence
- [Security Best Practices](/gh-aw/introduction/architecture/) - Authentication and security
- [Reusing Workflows](/gh-aw/guides/packaging-imports/) - Sharing workflows
**Reference**: [Cross-Repository Operations](/gh-aw/reference/cross-repository/) · [Safe Outputs](/gh-aw/reference/safe-outputs/) · [GitHub Tools](/gh-aw/reference/github-tools/) · [Authentication](/gh-aw/reference/auth/) · [Reusing Workflows](/gh-aw/guides/packaging-imports/)
Comment on lines +384 to +388
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

This page now uses a non-standard "## Related" section with inline link lists. Across the docs, the established convention is to use separate "## Related Patterns" and "## Related Documentation" headings (e.g., docs/src/content/docs/patterns/multi-repo-ops.md:256-269, docs/src/content/docs/patterns/central-repo-ops.mdx:401-407). Consider keeping those headings here (even if you keep the compact inline link format) to maintain consistent navigation and searchability.

This issue also appears on line 388 of the same file.

See below for a potential fix:

## Related Patterns

**Patterns**: [MultiRepoOps](/gh-aw/patterns/multi-repo-ops/) · [Orchestration](/gh-aw/patterns/orchestration/) · [IssueOps](/gh-aw/patterns/issue-ops/)

## Related Documentation

Copilot uses AI. Check for mistakes.