AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Docs Feedback

Open
#1,834 1 comment 0 reactions 0 assignees View on GitHub
Documentation good first issue help wanted
Dominant language
C++
Stars
2.1k
Forks
503
PR merge metrics
No merged PRs in 30d

Description

Thought I would share some notes I took while deep diving the Authoring documentation:

- The reference definition in [Roles](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#roles) seems to be backwards with the Note stating that "The reference role has sometimes been misinterpreted as being the space in which “reference art” is stored in."

- The 'rendering' role definition seems to be missing. It's defined in the OpenColorIO Confluence and is present in the reference-config. Not sure if this is intentional.

- Some clarity on the config's scene_reference would be good to have. Maybe in the first paragraph of [colorspaces](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#id13)? Quoting Carol Payne's answer on Slack:
"The reference space of an ocio config is implicit - it’s the colorspace in the config all others are defined to and from, and as such doesn’t need a definition. As you noted, this has historically been the first colorspace in the list, but I don’t believe there is a code reason other than convention for this."

- I was a little confused in [family_separator](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#family-separator). It states that "If no separator is defined, the Menu Helpers API will not generate hierarchical menus." However, in the reference-config, the family_separator value is not defined and hierarchical menus are present (e.g Input/ARRI, Input/Sony, etc.) Does this mean that family_separator's default value is '/' when not defined or simply a bug?

- A link to [Authoring Configurations](https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html) would be handy in [Quick Start for Config Authors](https://opencolorio.readthedocs.io/en/latest/quick_start/for_config_authors.html)

Cheers!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.