OpenAssetIO / OpenAssetIO/OpenAssetIO-TraitGen
Add complete example/docs on adding traits and specifications
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
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 https://github.com/OpenAssetIO/OpenAssetIO/issues/946
Out of scope
- CI/build system integration
- In-depth usage examples
- C++
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the main API orientation documentation and the format decision tracked in issue #946. Add the host-specific YAML example with cross-package trait references, basic CLI generation and Python usage examples, plus best-practice warnings; done means all listed in-scope sections are documented without adding CI, in-depth usage or C++ content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100