-
Notifications
You must be signed in to change notification settings - Fork 32
Closed
Description
I would like to have the specification described in markdown files which are generated automatically based upon the schema definition files.
After some research & testing it appears that https://github.com/adobe/jsonschema2md/ can be used and it won't need an additional runtime ie go/python.
The Hope is once the docs are of quality ie all titles are set, they can be published to openTelemetry.io to maximise visibility/understanding.
An example of using the tool can be seen at: https://github.com/thompson-tomo/opentelemetry-configuration/tree/feature/%23255_MarkdownDocs/docs/spec
Metadata
Metadata
Assignees
Labels
No labels