hashicorp / hashicorp/terraform-plugin-codegen-spec

Consider including auto-generated JSON schema docs

Open
#54 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
12
Forks
9
Avg merge
2d 13h
Merged PRs (30d)
1

Description

There are tools available, such as [jsonschema2md](https://github.com/adobe/jsonschema2md) which could be used to generate markdown documentation from the JSON schema.

We might want to consider using this tool, or another like it, in order to (auto) generate markdown documentation to accompany the schema.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.