KhronosGroup / KhronosGroup/Vulkan-Loader
Better document valid/invalid json manifests
- Dominant language
- C
- Stars
- 695
- Forks
- 343
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 17
Description
**What enhancement are you suggesting for the Vulkan Loader? Please describe in detail. **
Recently, an issue was reported that came from the Shader Object Extension Implementation Layer using a raw number instead of a string in its manifest. The loader expects a string, and the examples in the docs use strings. Yet this isn't obvious to the reader since it isn't clearly defined.
There are two solutions, one is to document the exact json types the loader expects in every field, and the second is to create a proper JSON Schema that can be used programatically.
Contributor guide
Research direction
Check open PR #1273 first, since related work is already underway. Review the existing manifest examples and loader documentation, then define whether completion means documenting the exact JSON types for every field or providing a usable JSON Schema.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100