Skip to content

[WIP] docs: Add CoprrectionOps#28676

Open
mnkiefer wants to merge 9 commits intomainfrom
add-shadow-ops
Open

[WIP] docs: Add CoprrectionOps#28676
mnkiefer wants to merge 9 commits intomainfrom
add-shadow-ops

Conversation

@mnkiefer
Copy link
Copy Markdown
Collaborator

@mnkiefer mnkiefer commented Apr 27, 2026

  • Adds new design pattern CorrectionOps to improve workflows using trusted human corrections without retraining models.

@mnkiefer mnkiefer self-assigned this Apr 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

Smoke CI completed successfully!

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@mnkiefer mnkiefer changed the title Add shadow ops docs: Add Organization practices & CorrectionOps Apr 27, 2026
@mnkiefer mnkiefer marked this pull request as ready for review April 27, 2026 09:03
Copilot AI review requested due to automatic review settings April 27, 2026 09:03
@mnkiefer mnkiefer changed the title docs: Add Organization practices & CorrectionOps [WIP] docs: Add Organization practices & CorrectionOps Apr 27, 2026
@github-actions github-actions Bot mentioned this pull request Apr 27, 2026
Copy link
Copy Markdown
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

Adds new documentation covering organization-scale workflow practices and introduces the CorrectionOps design pattern for improving workflows using trusted human corrections (without retraining models).

Changes:

  • Add new CorrectionOps pattern documentation page.
  • Add new Organization Practices section with pages for Safe Rollout and Sharing Workflows.
  • Update glossary, sidebar navigation, and redirects to surface the new docs and route legacy URLs.
Show a summary per file
File Description
docs/src/content/docs/reference/glossary.md Adds glossary entries for CorrectionOps and organization-practice terms.
docs/src/content/docs/patterns/correction-ops.md New pattern page describing CorrectionOps and a starter architecture.
docs/src/content/docs/organization-practices/index.mdx New landing page for the Organization Practices docs section.
docs/src/content/docs/organization-practices/safe-rollout.md New guidance on staged → shadow → direct-write rollout progression.
docs/src/content/docs/organization-practices/sharing-workflows.md New guidance on workflow sharing models and governance questions.
docs/astro.config.mjs Adds redirects for legacy shadow URLs and adds sidebar entries for new sections/pages.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (2)

docs/src/content/docs/patterns/correction-ops.md:24

  • Spelling is inconsistent with the rest of the docs: this repo predominantly uses US spelling “labeling” (single “l”). Consider changing “labelling” → “labeling” here.
Typical fits include labelling and classification, routing and prioritization, moderation and approvals, and summaries or recommendations that humans later correct.

docs/src/content/docs/patterns/correction-ops.md:279

  • Spelling is inconsistent with the rest of the docs: this repo predominantly uses US spelling “labeling” (single “l”). Consider changing “labelling” → “labeling” here.
Discussion labelling, routing, moderation, prioritization, approvals, and summaries can all reuse this shape. The production object changes, but the CorrectionOps setup does not.
  • Files reviewed: 6/6 changed files
  • Comments generated: 4

Comment thread docs/src/content/docs/reference/glossary.md Outdated
Comment thread docs/src/content/docs/reference/glossary.md Outdated
Comment thread docs/src/content/docs/patterns/correction-ops.md
Comment thread docs/src/content/docs/patterns/correction-ops.md Outdated
mnkiefer and others added 2 commits April 27, 2026 11:14
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github github deleted a comment from github-actions Bot Apr 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

Smoke CI completed successfully!

@github-actions
Copy link
Copy Markdown
Contributor

✅ smoke-ci: safeoutputs CLI comment + comment-memory run (24986680978)

Generated by Smoke CI for issue #28676 ·

@github-actions

This comment has been minimized.

@github-actions
Copy link
Copy Markdown
Contributor

Hey @mnkiefer 👋 — great work pushing forward the Organization Practices section and the CorrectionOps pattern! These are valuable additions to the docs. A few thoughts to help get this across the finish line:

  • PR is still marked [WIP] — once the work is complete, be sure to remove the [WIP] prefix from the title so reviewers know it's ready for final review.
  • Consider splitting the PR — this mixes two distinct doc additions: a new Organization Practices section (Safe Rollout + Sharing Workflows) and a brand-new CorrectionOps design pattern (plus glossary entries). Keeping them separate would make each change easier to review independently and allow them to land at their own pace.
  • No tests present — while these are docs-only changes, if the project has any doc-validation or link-checking CI steps, confirm they pass before marking ready.

If you'd like to split this up with a coding agent, here's a ready-to-use prompt:

Split the current branch `add-shadow-ops` into two focused branches:

1. Branch `docs/org-practices` — include only:
   - docs/src/content/docs/organization-practices/index.mdx
   - docs/src/content/docs/organization-practices/safe-rollout.md
   - docs/src/content/docs/organization-practices/sharing-workflows.md
   - The corresponding astro.config.mjs redirect/nav entries for organization-practices

2. Branch `docs/correction-ops` — include only:
   - docs/src/content/docs/patterns/correction-ops.md
   - The glossary additions in docs/src/content/docs/reference/glossary.md
   - Any astro.config.mjs entries specific to correction-ops

Open a separate PR for each branch against `main`, with a clear title and description summarising what changes and why.

Generated by Contribution Check · ● 1.1M ·

@mnkiefer
Copy link
Copy Markdown
Collaborator Author

@copilot Create a new PR for the CorrectionOps design pattern and keep this PR for organization practices (guidance) only.

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

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

@mnkiefer
Copy link
Copy Markdown
Collaborator Author

@copilot Remove Organization Practices from this PR.

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/c759f2a5-b6aa-4540-9253-7c862e444e68

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

@copilot Remove Organization Practices from this PR.

Done in 11e81c2. Removed the Organization Practices files (index.mdx, safe-rollout.md, sharing-workflows.md), their sidebar entries and redirects in astro.config.mjs, and the Organization Practices, Safe Rollout, and Shadow Evaluation glossary entries. The CorrectionOps content remains in this PR.

@mnkiefer
Copy link
Copy Markdown
Collaborator Author

@copilot Update text: For sharing GitHub Agentic Workflows, they should support a few layers:

  1. Copy/install whole workflows: A repo should be able to pull in a workflow from another repo:
    gh aw add acme-org/agentic-workflows/ci-doctor@v1.2.0
    GitHub AW already supports this via gh aw add, gh aw add-wizard, version refs, and a source: field for later updates.
  2. Reusable workflow components: Shared pieces should be importable:
imports:
  - acme-org/shared-workflows/shared/security-setup.md@v2.1.0
  - acme-org/shared-workflows/shared/mcp/tavily.md@v1.0.0

AW supports imports: for shared tools, MCP servers, steps, jobs, and prompt snippets.
3. Parameterized templates: Shared workflows should take inputs:

imports:
  - uses: acme-org/shared-workflows/shared/reviewer.md@v1
    with:
      languages: ["go", "typescript"]
      severity: "high"

AW supports uses / with for parameterized imports.
4. Versioning and update flow: Enterprise sharing needs:

  • Semantic versions for stable workflows
  • Branch refs for dev
  • SHA pins for strict reproducibility
  • gh aw update to pull upstream changes
  • 3-way merge to preserve local edits
    AW documents this model directly.
  1. Private/internal sharing controls
    They should support:
  • Org-internal workflow catalogs
  • Private workflows that cannot be imported elsewhere
  • Access checks before install
  • Trusted-source warnings
    AW has access-based imports and private: true to block adding workflows to other repos.
  1. Import caching / lock behavior: Shared imports should be cached and compiled into .lock.yml so runs are reproducible. AW caches remote imports under .github/aw/imports/ by commit SHA.
  2. Cross-repo execution model: Separate from sharing definitions, workflows should support operating across repos: read other repos, check out code, and create safe outputs in target repos with explicit auth and allowlists. AW has cross-repo checkout, reading, and safe outputs via target-repo / allowed-repos.
    Currently, the guide should describe that the ideal enterprise pattern is one central "agentic-workflows" repo with versioned workflow templates and shared components, then consuming repos use gh aw add for full workflows and imports: for common modules.Note, that this may change in the future so add a banner a on other pages (this is new).

@mnkiefer mnkiefer changed the title [WIP] docs: Add Organization practices & CorrectionOps [WIP] docs: Add Organization practices Apr 27, 2026
@mnkiefer mnkiefer changed the title [WIP] docs: Add Organization practices [WIP] docs: Add CoprrectionOps Apr 27, 2026
Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

@copilot Update text: For sharing GitHub Agentic Workflows, they should support a few layers:

  1. Copy/install whole workflows: A repo should be able to pull in a workflow from another repo:
    `gh aw a...

Done in f269507. The sharing-workflows.md guide has been rewritten around the seven layers you described (whole workflow install, reusable imports, parameterized templates, versioning/update flow, private/internal controls, import caching and lock behavior, and cross-repo execution), with the recommended enterprise pattern (central agentic-workflows repo + gh aw add / imports:) summarized at the top. An evolving-guidance banner has been added to both the sharing-workflows.md page and the packaging-imports.mdx guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants