Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes/documentation refactor (WIP) #1810

Conversation

vade
Copy link
Contributor

@vade vade commented Nov 7, 2024

This PR contains the discussed and demo'd documentation refactoring as shown in Nov 7th TSC meeting.

The overall goal is to

  • increase legibility of the docs for technical and non technical users
  • provide reorganization of existing dev docs into clearer organizing principles

The state of this PR is currently WIP and requires community feedback and assistance on the following items:

  • Review high level info organization and iterate if needed
  • Review general language and correctness (typos, out of date info etc)
    • Specific doc pages that need help
      • Pipeline Architect Intro language - out of my wheelhouse. Suggestions welcome!
      • Roadmap
      • User Tutorials.
        • Can we put a Resolve <-> Premiere sample or something like it up?
        • Suggestions for taking the old use cases and converting to tangible tutorials?
  • Technical doc concerns
    • Deduplication of some autogenerated python documentation.
    • Figure out how to remove the sidebar from the body of the main index landing page!
    • Figure out how to clearly separate the Utils sidebar section from the lower auto generated Schema section

I've also taken the liberty to change some of the doc generation config to remove the disclosure of subheadings in the TOC and I felt it hurt legibility.

Looking forward to the feedback and thoughts.

@vade vade force-pushed the fixes/documentation_updates branch from 17a080c to 27c8b44 Compare November 7, 2024 19:52
@vade
Copy link
Contributor Author

vade commented Nov 7, 2024

Some additional thoughts

We might want to have a best practices / conventions document somewhere.

ie:
image

and the observation that the 'rate' on global start time on a timeline is often used to determine the rate of the sequence when importing from an NLE, which isnt semantically clear, but appears to be a convention many converters use. If you happen to define 0 time as a RationalTime() you'll get correct preview in OTIOView Raven, the AVFoundation Reader app, but importing to Premiere or Resolve will net you a 1 fps sequence.

@reinecke reinecke merged commit 5fed4a9 into AcademySoftwareFoundation:documentation-refactor Nov 11, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants