AcademySoftwareFoundation / AcademySoftwareFoundation/OpenTimelineIO

Documentation Updates (new user sections)

Open
#1,814 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2k
Forks
351
Avg merge
1d 12h
Merged PRs (30d)
1

Description

This Issue continues the ongoing documentation work and is meant to capture new documentation to finish sections for the documentation refactor.

This is a bit of a call to action for the community.

* Guidance on the Pipeline Architect intro guide with language.
* Guidance on sample media to include with OTIO / OTIOD / OTIOZ files for users to base tutorials off of.
* Guidance on user facing tutorials. Can we make a set of tutorials which are lightweight introductions to common use cases for OTIO using the sample media and well known reference implementations?
* Roadmap needs attention if we want to include it

```[tasklist]
### Tasks
- [ ] Roadmap update
- [ ] Getting started tutorials
```

Contributor guide

Open the contributing guide

Research direction

No files or tests are identified in the issue. Review the existing Pipeline Architect introduction, documentation refactor sections, sample-media guidance, user-facing tutorials, and roadmap; done means completing the Roadmap update and Getting started tutorials tasks.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.