Submit a WorkBuddy Community Case
The community case collection gathers tasks people have actually run in WorkBuddy. Once merged, a case appears automatically in the community cases; classic tasks that are further reproduced and edited may later enter the field guide proper.
What a Good Case Must Answer
- What is the scenario: who, in what situation, ran into what problem.
- Which Skills were used: each Skill's purpose, source and required permissions.
- How it runs in WorkBuddy: inputs, key steps and task instructions.
- What was the outcome: deliverables, screenshots, GIFs or other proof.
- How to judge completion: clear, reviewable acceptance criteria.
Check for duplicates before submitting
First search the community cases and the bluebook table of contents to confirm the scenario or task isn't already covered. Same goal, same flow or just swapped input data — prefer extending an existing case. If a new case uses a clearly different Skill, method or delivery, explain the difference in the PR.
Submission Steps
- Search the case collection and bluebook to confirm no duplicate.
- Fork the AlephAITech/WorkBuddyGuide repository.
- Copy the case template in
.github/CASE_TEMPLATE.md. - Create
docs/cases/submissions/<case-slug>/index.md. - Put screenshots and assets in the
assets/folder of the same directory. - Run
npm installandnpm run docs:buildlocally. - Open a Pull Request and choose the Case PR template.
Use a short, lowercase English slug, for example:
docs/cases/submissions/daily-ai-news/
├── index.md
└── assets/
├── cover.png
└── workbuddy-result.pngYou don't need to edit the cases landing page. At build time the site reads every case's title, category, Skills, author and summary automatically.
Frontmatter Fields
Every case index.md must start with these fields:
---
title: Use WorkBuddy to auto-organize daily AI news
summary: Automatically collect information from multiple sources and generate a daily briefing
author: your-github-name
date: "2026-07-13"
category: Automation
difficulty: Medium
skills:
- Browser
- Feishu Docs
tags:
- AI News
- Information Tidying
---title, summary, author, date, category, difficulty and skills are required. Missing required fields fail the build so incomplete cases aren't published.
Content Structure
The body should at least include:
- Scenario description
- The task to accomplish
- Skills used
- Prerequisites
- Steps in WorkBuddy
- Prompts or task instructions
- Result in WorkBuddy
- Acceptance criteria
- Issues encountered
- Security and limits
- How to reuse
Images and Proof
- Prefer screenshots of the WorkBuddy process and final deliverables.
- Use meaningful English filenames; avoid
image-1.png. - Remove names, phone numbers, accounts, internal addresses, keys and other sensitive info.
- Don't submit client data, enterprise data or copyrighted content you can't publish.
- Compress image size while keeping text legible.
Review and Inclusion
Community cases are reviewed mainly for authenticity, completeness, safety and readability — they don't need to reach the editorial level of a bluebook chapter from the start.
We keep watching cases for reproducibility, representativeness and reader feedback. Before a case enters the bluebook proper, the editorial team validates again and talks to the original author; the official chapter keeps the author's credit and a link to the original case.