Video tutorials for a monorepo: one .ondaclip folder
A web dashboard and a mobile app in the same repo? Create video tutorials for a monorepo with a single .ondaclip folder at the root.
For Developers and tech leads working in a monorepo with several web or mobile apps
When you create video tutorials for a monorepo, the first question is simple:
one setup per app, or one for the whole repo? Plenty of teams keep several
apps side by side: a web dashboard, an admin panel, a mobile app or two.
Ondaclip films all of them from a single .ondaclip/ folder at the root.
List the apps in a monorepo in config.yaml
In config.yaml, the products: key lists the apps you want filmed, and only
those. Your repo can hold other apps too.
products:
dashboard:
name: Dashboard
freshness: { appPaths: [apps/web/dashboard] }
staff:
name: Mobile app
platform: android
freshness: { appPaths: [apps/mobile/staff] }
Each product gets its own tutorials folder and its own publication list. Shared settings (languages, voice, environment) live at the top of the file, and each product only overrides what’s different for it.
Each pull request checks the right app
With appPaths, a pull request on the mobile app only checks the mobile app’s
tutorials. And the agent that writes a tutorial only reads that app’s code, so
it works faster and makes fewer mistakes.
It’s all covered in the .ondaclip folder. To write the first tutorial for each app, follow your first tutorial.
Frequently asked questions
Does Ondaclip film every app in a monorepo?
No, only the ones you list under products: in .ondaclip/config.yaml. Your repo can hold other apps too.
Do I need a separate .ondaclip folder for each app?
No. A single .ondaclip folder at the root describes every product, and each product gets its own tutorials and publication list.
Does a pull request on one app check the tutorials of the other apps?
No. With appPaths, Ondaclip only checks the tutorials for the app whose code changed.
Join the early access.
We open Ondaclip to a few teams at a time, and help each one film its first tutorials.
Request early access