Improve `gen-schema-doc` script dev experience
Open
enhancement
tech-debt
- Dominant language
- TypeScript
- Stars
- 249
- Forks
- 176
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 20
Description
Right now, executing the `gen-schema-doc` script without setting things up correctly, results in a cryptic error that doesn't tell you that the Python library `json-schema-for-humans` is needed to run the underlying `doc-schema.js` script.
Simply executing `pip install json-schema-for-humans` beforehand fixes this (assuming pip is available). We should either document this somewhere, or make sure that the `doc-schema.js` script gives a more descriptive error when failing.
Contributor guide
Assessment
This issue has not been assessed yet.