Case Submission
We welcome community-contributed tutorials and use cases. Every contribution helps someone discover a new way to use AI in their work.Content Principles
All submissions must follow these five principles:| Principle | Requirement |
|---|---|
| Reproducible | Describe the environment, inputs, steps, deliverables, and expected results clearly enough for anyone to follow |
| Verifiable | Explain how to confirm the task is truly complete — not just the process, but the acceptance criteria |
| Facts vs. Experience | Product facts need sources; personal experience should state its applicability scope |
| Safety First | When involving file writes, accounts, keys, publishing, or external operations, state permissions and risks |
| Privacy & Copyright | Do not submit personal data, access credentials, or content you don’t have permission to share |
Tutorial Structure
Each tutorial should follow the five-element structure used throughout our Tutorials section:- Scenario — A real work situation the reader will recognize
- Materials — Files, data, or context needed to start
- Steps — Step-by-step walkthrough (screenshots welcome)
- Deliverable — The concrete output produced
- Acceptance Criteria — How to verify the result is correct
Submitting
- Open a GitHub Issue in the myrm-agent repository with the label tutorial
- Include your tutorial content in the issue body (Markdown format following the five-element structure above)
- Attach any screenshots or supporting files
- The maintainer team reviews your submission, then integrates it into the documentation site
Review Criteria
Submissions are reviewed for:- Adherence to the five content principles
- Completeness of the five-element structure
- Accuracy of steps and expected results
- Writing clarity and readability
- No product secrets, credentials, or PII