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

Add complete example/docs on adding traits and specifications #30

Open
Tracked by #92
foundrytom opened this issue May 26, 2023 · 1 comment
Open
Tracked by #92

Add complete example/docs on adding traits and specifications #30

foundrytom opened this issue May 26, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation task

Comments

@foundrytom
Copy link
Contributor

foundrytom commented May 26, 2023

What

Properly document the process of adding custom traits + specifications to a Host, so we have good examples of the ideas, process and resulting YAML, including cross-package references (eg. back to MediaCreation)

ACs

  • Example of adding host-specific specifications following on from a link to the main API docs.
    • Pointers to API orientation docs
    • Worked YAML authoring example with cross-package trait references
    • Basic CLI generation
    • Basic usage example (python)
    • Calls out best practices and "dont do this" in appropriate sections.
    • Format TBD in [Investigation] Tooling for tutori-docs OpenAssetIO#946

Out of scope

  • CI/build system integration
  • In-depth usage examples
  • C++
@foundrytom foundrytom added the documentation Improvements or additions to documentation label May 26, 2023
@elliotcmorris elliotcmorris added this to the v1.0.0-beta.1 milestone Apr 19, 2024
@elliotcmorris
Copy link
Contributor

Relates to / may be prerequisite of : OpenAssetIO/OpenAssetIO-MediaCreation#92

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation task
Projects
Status: Backlog
Development

No branches or pull requests

3 participants