mirror of
https://github.com/onestardao/WFGY.git
synced 2026-04-28 11:40:07 +00:00
Create README.md
This commit is contained in:
parent
4f6ff1edb2
commit
0a5d6aae69
1 changed files with 118 additions and 0 deletions
118
ProblemMap/Atlas/Fixes/community/workflows/README.md
Normal file
118
ProblemMap/Atlas/Fixes/community/workflows/README.md
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
<!--
|
||||
AI_NOTE_START
|
||||
|
||||
Document role:
|
||||
This file explains what belongs in the community workflows folder.
|
||||
|
||||
How to use this file:
|
||||
1. Read this page before adding any workflow-based contribution.
|
||||
2. Use this page to decide whether your contribution is really a workflow recipe.
|
||||
3. Use this page together with:
|
||||
- [Community Fix Lab](../README.md)
|
||||
- [Contribution Checklist](../../templates/contribution-checklist.md)
|
||||
- [Fix Recipe Template](../../templates/fix-recipe-template.md)
|
||||
|
||||
What this file is:
|
||||
- A folder-level guide for workflow recipes
|
||||
- A scope filter for procedural troubleshooting contributions
|
||||
- A lightweight quality guide for route-aware fix workflows
|
||||
|
||||
What this file is not:
|
||||
- Not a place for giant undocumented pipelines
|
||||
- Not a place for architecture diagrams with no operational recipe
|
||||
- Not a replacement for official repair grammar
|
||||
|
||||
Reading discipline for AI:
|
||||
- Workflow recipes should remain grounded in atlas routing and first repair logic.
|
||||
- Do not upgrade workflow recipes into official doctrine automatically.
|
||||
|
||||
AI_NOTE_END
|
||||
-->
|
||||
|
||||
# Community Workflows
|
||||
|
||||
## Workflow recipes, process fixes, and route-aware troubleshooting flows
|
||||
|
||||
This folder is for community-contributed workflow recipes that show how to move from atlas routing into a usable troubleshooting process.
|
||||
|
||||
Typical contributions here include:
|
||||
|
||||
- step-by-step repair flows
|
||||
- workflow-oriented fix recipes
|
||||
- route-first escalation paths
|
||||
- small system troubleshooting playbooks
|
||||
- procedural guidance for one clear failure class
|
||||
|
||||
---
|
||||
|
||||
## What belongs here
|
||||
|
||||
Good workflow contributions include:
|
||||
|
||||
- one repair flow for one family
|
||||
- one route-then-repair sequence
|
||||
- one benchmark rerun process
|
||||
- one troubleshooting workflow for a known recurring case
|
||||
- one escalation flow from atlas first move into deeper WFGY exploration
|
||||
|
||||
A good workflow recipe should be:
|
||||
|
||||
- scoped
|
||||
- readable
|
||||
- sequential
|
||||
- realistic
|
||||
- explicit about expected result
|
||||
|
||||
---
|
||||
|
||||
## What does not belong here
|
||||
|
||||
Please do not use this folder for:
|
||||
|
||||
- giant architecture plans with no runnable steps
|
||||
- vague “best practices” with no route or case
|
||||
- workflows that skip diagnosis entirely
|
||||
- workflows that claim guaranteed success without limits
|
||||
- giant systems documentation unrelated to atlas use
|
||||
|
||||
---
|
||||
|
||||
## Suggested workflow pattern
|
||||
|
||||
A useful workflow recipe usually includes:
|
||||
|
||||
1. target case or family
|
||||
2. routing assumption
|
||||
3. first repair move
|
||||
4. follow-up checks
|
||||
5. escalation condition
|
||||
6. expected output or success condition
|
||||
|
||||
This is enough for a strong community workflow contribution.
|
||||
|
||||
---
|
||||
|
||||
## Suggested naming style
|
||||
|
||||
Examples:
|
||||
|
||||
- `f4-execution-closure-workflow-v1.md`
|
||||
- `f5-observability-uplift-workflow-v1.md`
|
||||
- `f3-continuity-repair-workflow-v1.md`
|
||||
|
||||
---
|
||||
|
||||
## Before contributing
|
||||
|
||||
Please read:
|
||||
|
||||
- [Community Fix Lab](../README.md)
|
||||
- [Contribution Checklist](../../templates/contribution-checklist.md)
|
||||
- [Fix Recipe Template](../../templates/fix-recipe-template.md)
|
||||
- [Misrepair Patterns v1](../../official/misrepair-patterns-v1.md)
|
||||
|
||||
---
|
||||
|
||||
## One-line status
|
||||
|
||||
**This folder holds community workflow recipes that turn atlas routing into concrete repair sequences and troubleshooting flows.**
|
||||
Loading…
Add table
Add a link
Reference in a new issue