Skip to content
ondaclipdocs

The publication list

.ondaclip/publication.yaml sets which tutorials are published, in which chapter and in what order. A tutorial that isn’t listed here isn’t published.

sections: # optional: groups of chapters on the page
- id: basics
icon: compass
title: { en-US: Getting started, es-MX: Para empezar }
chapters:
- number: 1
section: basics # required when the file has sections
title: { en-US: Find your way around, es-MX: Ubíquese }
tutorials:
- id: client-home
icon: home
description:
en-US: The home page and what it shows.
es-MX: La página de inicio y lo que muestra.

Publishing writes to the folder you chose during setup:

  • one video per tutorial and language, with its poster;
  • manifest.json: sections, chapters, tutorials, titles, descriptions, durations, videos and posters, per language.

Your app reads manifest.json and shows the videos wherever you want: a help page, a “getting started” panel, a link next to a feature.

  • When the file has sections, every chapter must name one. An unknown or missing section stops the publish.
  • A tutorial that’s already published stays published, unchanged, until you remove it from this file. Removing it takes it off the page.

Check the file before you commit it, with publication.schema.json or validate_publication in the MCP server. For the whole folder, see the .ondaclip folder.