Docs Feedback

[johnjoumaa]

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

• The reference definition in 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? 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. 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 would be handy in Quick Start for Config Authors

Cheers!

[doug-walker]

Thank you for the feedback John! Adding the "good first issue" label as this would be an easy one for a new contributor to attempt.