Skip to content

docs: Add Sharing Workflows guide#28789

Closed
mnkiefer wants to merge 1 commit intomainfrom
add-correction-ops
Closed

docs: Add Sharing Workflows guide#28789
mnkiefer wants to merge 1 commit intomainfrom
add-correction-ops

Conversation

@mnkiefer
Copy link
Copy Markdown
Collaborator

@mnkiefer mnkiefer commented Apr 27, 2026

  • Adds new guide on sharing workflows

Co-authored-by: Copilot <copilot@github.com>
@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
Copy link
Copy Markdown
Contributor

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

Generated by Smoke CI for issue #28789 ·

@github-actions
Copy link
Copy Markdown
Contributor

📸 Visual Regression Check — Unable to Complete

The visual regression check could not be performed because the sandbox environment's network firewall blocks all outbound connections, including to localhost:4321 where the documentation dev server is running.

What was attempted

  • Playwright navigation to `(localhost/redacted)
  • curl HTTP request to the dev server
  • Network connectivity test

All attempts returned Permission denied due to the network firewall policy.

PR Changes Summary

This PR adds a new documentation page: CorrectionOps (docs/src/content/docs/patterns/correction-ops.md) — a 128-line page covering workflow sharing patterns across repositories. The astro.config.mjs was updated to add the new page to the sidebar nav and add a redirect for the unhyphenated slug.

Since this is a new page addition (not a modification of existing pages), visual regressions on pre-existing pages are not expected. The new page follows the same layout/template as other pattern pages.

Manual Verification Recommended

To verify visually, run locally:

cd docs && npm run dev
# Then visit (localhost/redacted)

Check:

  • Mobile (375×812), Tablet (768×1024), Desktop (1440×900)
  • Sidebar shows "CorrectionOps" entry under Patterns
  • Redirect /patterns/correctionops//gh-aw/patterns/correction-ops/ works

Generated by Visual Regression Checker for issue #28789 · ● 463.9K ·

@github github deleted a comment from github-actions Bot Apr 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Hey @mnkiefer 👋 — thanks for adding the CorrectionOps pattern to the docs! The navigation wiring in astro.config.mjs looks right and the PR is nicely scoped. However, there's a significant content mismatch that needs fixing before this can merge:

  • Wrong content in correction-ops.md — the frontmatter title is "Sharing Workflows" and the entire body describes workflow sharing/import mechanics (layers 1–7 of cross-repo sharing, governance of shared templates, etc.). None of this is about CorrectionOps. It looks like content from a different page was accidentally used here. The file should describe the CorrectionOps design pattern — trusted human corrections that improve agentic workflows without retraining models.

If you'd like a hand, here's a prompt you can assign to your coding agent to fix it:

Fix the content of docs/src/content/docs/patterns/correction-ops.md in the `add-correction-ops` branch of github/gh-aw.

The file currently contains content about "Sharing Workflows" (cross-repo import layers, versioning, governance), which is wrong.

Replace it with a proper CorrectionOps pattern page that:
1. Sets the frontmatter title to "CorrectionOps" and an appropriate description (e.g. "Improve agentic workflows using trusted human corrections without retraining models.").
2. Explains what CorrectionOps is: a design pattern where human reviewers provide structured corrections to agent outputs, which are captured and fed back into future workflow runs as guidance rather than requiring model fine-tuning.
3. Follows the same structure as sibling pattern pages (e.g. docs/src/content/docs/patterns/chat-ops.md) — use that as a template for headings, badge style, and related-docs section.
4. Includes a concrete workflow example showing how a correction event is captured and surfaced to subsequent agent runs.

Generated by Contribution Check · ● 1.7M ·

@mnkiefer
Copy link
Copy Markdown
Collaborator Author

Split into 2 separate PRs

@mnkiefer mnkiefer closed this Apr 28, 2026
@mnkiefer mnkiefer changed the title docs: Add CorrectionOps docs: Add Sharing Workflows guide Apr 29, 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.

1 participant