How to Participate
Report problems, improve existing courses, or write a new one.
Ways to help
- Report a problem in a course — wrong information, a typo, a confusing card — open an issue on that course's own repo (linked from its page on this site). For a problem with the app itself, open an issue here.
- Fix or improve a course — edit the
source/*.csvfiles in that course's repo and open a pull request against it. - Write a new course — see the walkthrough below.
Writing a new course
Every course is its own repo under the yaaddi-courses organization.
- Click Use this template on yaaddi-courses/course-template to create the new course repo.
- Follow that repo's README and
AUTHORING.md
— deck structure, card-type variety, how many practice cards per
concept,
meta.jsonfields, and more. - In the repo, run the validator:
python validate_course.py . --source— it catches dangling references, missing media, unknown card types, and more. Then build the zip:python build_course_zip.py . - The repo's own workflow runs the same validator on every pull request and push.
- Once it is merged to
main, add theyaaddi-coursetopic to the repo. The catalog picks it up on its next scheduled rebuild (every 6 hours) — no pull request against the catalog is needed.
License
Course content is licensed under
PolyForm Noncommercial 1.0.0
— each course repo carries its own LICENSE. If you're
contributing a course built from a source with its own license, say so
in that course's own repo rather than assuming.