Write documentation for explaining OTIO in 5 levels of complexity - Githubissues

OpenTimelineIO / otio-youtube-example

Example Python script which turns a YouTube video and description into an OpenTimelineIO OTIO file.

Apache License 2.0

5 stars 2 forks source link

Write documentation for explaining OTIO in 5 levels of complexity #39

Open utsab opened 2 years ago

utsab commented 2 years ago

We would like to explain OTIO in five levels of complexity. Currently, the documentation covers the first two levels only.

Level 1: The high level purpose of OTIO
Level 2: OTIO is a file format, an API, and a collection of adaptors and plugins.
Level 3: The technology stack of the OTIO codebase
Level 4: Important design patterns / architectural components
Level 5: Walkthrough of the codebase

To test your changes, follow the instructions on installing MkDocs.