Skip to content

docs: Add CoprrectionOps#28676

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

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

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

This comment has been minimized.

@github-actions

This comment has been minimized.

@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
@github-actions
Copy link
Copy Markdown
Contributor

Hey @mnkiefer 👋 — thanks for putting together this documentation on CorrectionOps! The content itself looks well-structured and on-topic. However, there are a couple of things to address before this can move forward:

  • Contribution process — Per the project's CONTRIBUTING.md, non-core team members should not submit pull requests directly. Instead, the preferred flow is to open a detailed issue with an agentic plan, and a core team member will implement it using a coding agent.
  • WIP status + title typo — The PR is still marked as a draft/WIP and the title contains a typo ("CoprrectionOps" → "CorrectionOps").

To move this contribution forward, please consider closing this PR and opening an issue instead with your documentation plan. Here's a prompt you can hand to your AI coding agent to help:

Create a GitHub issue for the github/gh-aw repository proposing new documentation for the CorrectionOps organization practice.

The issue should include:
1. A description of what CorrectionOps means in the context of agentic workflows
2. The proposed documentation structure (sections, pages, nav entries)
3. Key concepts to cover: safe rollout, workflow sharing, correction patterns
4. Specific file paths where new markdown pages should be created under docs/
5. Any redirects or glossary entries needed

Follow the Diátaxis documentation framework used by this project. Provide a complete, step-by-step implementation plan so a core team member can hand it directly to a coding agent.

Generated by Contribution Check · ● 1M ·

@github github deleted a comment from Copilot AI Apr 27, 2026
@mnkiefer
Copy link
Copy Markdown
Collaborator Author

@mnkiefer mnkiefer closed this Apr 27, 2026
@github github deleted a comment from Copilot AI Apr 27, 2026
@github github deleted a comment from Copilot AI Apr 27, 2026
@github github deleted a comment from github-actions Bot Apr 27, 2026
@github github deleted a comment from github-actions Bot Apr 27, 2026
@github github deleted a comment from github-actions Bot Apr 27, 2026
@mnkiefer mnkiefer changed the title [WIP] docs: Add CoprrectionOps docs: Add CoprrectionOps Apr 27, 2026
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