WFGY/ProblemMap/Atlas/Fixes/community/colab/README.md
PSBigBig + MiniPS 4ddf7bc87a
Update README.md
2026-03-17 17:01:06 +08:00

7 KiB

Community Colab 📓

Notebook-based community demos and runnable repair assets

Quick links:


If the Community Fix Lab is the broader entry page for community repair assets, this folder is the notebook lane for runnable teaching, replay-first case walkthroughs, and compact troubleshooting demos. 🧭

Use this folder when a case becomes easier to understand through a small runnable notebook, not just through static text, JSON fixtures, or prompt-only examples.

Short version:

official layer gives the repair grammar
this folder helps turn that grammar into runnable notebook examples


Quick start 🚀

I want to contribute a notebook

Use this path:

  1. decide whether the asset is really a notebook contribution
  2. route the case first with the atlas
  3. keep the notebook scoped to one case, one family, or one boundary cut
  4. show baseline behavior and repaired behavior clearly
  5. explain how to run it and what result to expect

I want to browse notebook assets

Use this path:

  1. open one notebook with a clear routing context
  2. identify the target case or family
  3. inspect the baseline behavior
  4. inspect the repaired behavior
  5. check the result note and limitations

Short version:

route first
keep the notebook small
make the behavior legible


Colab quick map 🗂️

If your asset is mainly... Best folder
a runnable notebook walkthrough Colab
a structured fixture or machine-readable case JSON
a prompt asset or repair prompt pack Prompts
a step-by-step repair sequence Workflows
a before / after comparison slice Benchmark Reruns
a portable one-case bundle Reproduction Packs

This folder is the right place when the notebook itself is the teaching surface.


What belongs here

Good contributions for this folder include:

  • a notebook that demonstrates one family-level repair pattern
  • a notebook that replays one case clearly
  • a notebook that compares baseline and repaired outputs
  • a notebook that explains one boundary cut through runnable examples
  • a notebook that shows atlas routing before a deeper WFGY step

A notebook here should be:

  • small enough to understand
  • easy to run
  • clearly scoped
  • tied to one clear routing logic
  • honest about what it does and does not prove

What does not belong here 🚫

Please do not use this folder for:

  • giant experimental notebooks with no explanation
  • notebooks with no routing context
  • notebooks that require many hidden manual steps
  • random prompt playgrounds with no case framing
  • notebooks that pretend to be official flagship demos
  • notebooks that make large benchmark claims without a clear method note

If the notebook is not clearly connected to atlas routing, it probably belongs somewhere else.


Suggested notebook pattern 🧩

A good notebook usually includes:

  1. short experiment description
  2. case or family target
  3. routing expectation
  4. baseline behavior
  5. repaired behavior
  6. short result interpretation
  7. expected output or success note

That is enough for a useful community notebook.


A clean contribution can look like this:

  • one notebook file
  • one short README section inside the notebook or next to it
  • one small fixture if needed
  • one clear expected result note

Suggested naming style:

  • f1-grounding-demo-community-v1.ipynb
  • f5-observability-trace-demo-v1.ipynb
  • f7-container-repair-demo-v1.ipynb

Keep names descriptive and compact.


What a good first notebook looks like 🌱

A strong first contribution usually looks like this:

  • one case
  • one notebook
  • one routing decision
  • one baseline view
  • one repaired view
  • one short explanation of what changed

Small, clean, scoped notebooks are much better than giant messy ones.


Before contributing 📚

Please read:

This helps keep notebook contributions aligned with atlas grammar instead of drifting into random demos.


Review standard

A notebook contribution is much more likely to be accepted if it is:

  • clearly named
  • easy to read
  • easy to run
  • connected to atlas routing
  • explicit about expected output
  • honest about limitations

Messy power is still messy.
Clean small notebooks are more valuable.


Next steps

After this page, most contributors continue with:

  1. Open Colab Template
  2. Open Contribution Checklist
  3. Back to Community Fix Lab
  4. Back to Official Fixes

If you want the broader product surface:


One-line status 🌍

This folder holds community notebooks that turn atlas repair grammar into runnable teaching or troubleshooting assets.