Commit 51139f6
feat: Redesign automation examples as card-based marketplace linked to use cases (#454)
* feat: redesign automation examples as card-based marketplace linked to use cases
- Redesign automation examples page with card-based UI organized into
'Use Case Automations' and 'General Automations' sections
- Each use-case automation card links to the full guide, relevant plugin,
and includes a copyable prompt with Prompt/Plugin tabs
- General automations displayed as a 3-column card grid for discoverability
- Tips section collapsed into AccordionGroup to reduce visual noise
- Add 'Automate This' sections to 4 use case pages (vulnerability
remediation, code review, incident triage, dependency upgrades) with
ready-to-use automation prompts and link to the examples page
- Update use-cases overview with new 'Automate Any Use Case' section
showing cards for Automation Templates, Plugins, and SDK
- Cross-link use cases ↔ automations ↔ plugins bidirectionally
Co-authored-by: openhands <openhands@all-hands.dev>
* feat: add CI workflow to auto-sync use-case automation cards from YAML data
- Add _data/use-case-automations.yaml as single source of truth for
use-case → automation mappings (title, icon, prompt, plugin link, etc.)
- Add .github/scripts/sync_use_case_automations.py to generate/validate
the auto-generated MDX sections between marker comments
- Add .github/workflows/sync-use-case-automations.yml CI check that
runs on PRs touching the data file, examples page, or use-case pages
- Add {/* BEGIN/END */} marker comments to examples.mdx and 4 use-case
pages so the script knows which sections to regenerate
Workflow:
1. Edit _data/use-case-automations.yaml (add/modify use cases)
2. Run: python .github/scripts/sync_use_case_automations.py
3. Commit the YAML + regenerated MDX files
4. CI validates everything stays in sync
Co-authored-by: openhands <openhands@all-hands.dev>
* refactor: use frontmatter as source of truth instead of separate YAML file
The automation content for each use case is now defined in the use-case
page's own frontmatter (automation: block). The sync script reads those
pages directly — no separate _data/ file to maintain.
- Remove _data/use-case-automations.yaml
- Add automation: frontmatter to 4 use-case pages (vulnerability-
remediation, code-review, incident-triage, dependency-upgrades)
- Rewrite sync script to parse MDX frontmatter and generate the
examples page cards + Automate This sections from it
- Simplify workflow triggers (no more YAML data path)
Adding a new use-case automation:
1. Add automation: block to the use-case page's frontmatter
2. Add BEGIN/END:automate-this markers where the section should go
3. Run: python .github/scripts/sync_use_case_automations.py
4. Commit the updated files — CI validates on every PR
Co-authored-by: openhands <openhands@all-hands.dev>
* fix: remove duplicated Automate This content, link back to examples page
The Automate This sections were duplicating the prompt already defined
in frontmatter. Now use-case pages just have a simple card linking back
to the automation examples page (with an anchor to the specific use
case). The prompt content lives in one place only — the frontmatter —
and the sync script copies it to examples.mdx.
- Remove generated Automate This blocks and markers from use-case pages
- Replace with a static Card linking to examples page anchor
- Remove unused intro field from frontmatter
- Simplify sync script to only generate the examples page
Co-authored-by: openhands <openhands@all-hands.dev>
* fix: use-case pages own the full automation content, examples page is a card index
Use-case pages are now the single source of truth:
- Frontmatter has only card metadata (title, icon, short description)
- Page body has the full 'Automate This' section with prompts, context,
and plugin links — this is what users actually read and copy
The automation examples page is just a card grid that links to each
use-case page's #automate-this section. The sync script generates
those cards from the frontmatter metadata.
Co-authored-by: openhands <openhands@all-hands.dev>
* feat: add doc page link to each automation prompt
Each prompt now ends with 'Learn more at <url>' pointing back to the
use-case documentation page, so users (and agents) always have context
on where the prompt came from.
Co-authored-by: openhands <openhands@all-hands.dev>
* refactor: merge examples into overview, address review feedback
Review fixes:
- Remove card_title duplication — use page title instead
- Rename card_description to summary (simpler frontmatter)
- Add field validation with clear error messages for missing fields
- Add marker validation (fail loudly on missing/misordered markers)
- Add 13 tests covering parsing, generation, and error cases
Page merge:
- Merge automations/examples.mdx into automations/overview.mdx
(single page with overview + use-case cards + general templates)
- Delete the separate examples page
- Update docs.json navigation
- Fix all internal links across the site
Co-authored-by: openhands <openhands@all-hands.dev>
* fix: simplify error handling, add redirect for deleted examples page
- Replace confusing 'all(f" {rel}" not in e ...)' with simple
'file_has_errors' boolean flag per reviewer suggestion
- Add redirect from /automations/examples to /automations/overview
so external links don't 404
Co-authored-by: openhands <openhands@all-hands.dev>
---------
Co-authored-by: openhands <openhands@all-hands.dev>1 parent 6e7edd0 commit 51139f6
14 files changed
Lines changed: 855 additions & 164 deletions
File tree
- .agents/skills/verify
- .github
- scripts
- workflows
- openhands/usage
- automations
- use-cases
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
0 commit comments