terraform-provider-github icon indicating copy to clipboard operation
terraform-provider-github copied to clipboard

[MAINT]: Migrate Docs from Legacy Provider Docs

Open deiga opened this issue 3 weeks ago • 0 comments

Describe the need

We are currently hand rolling docs, which leads to inconsistencies in docs contents and code.

There exists a tool for auto-generating docs based on source code, which should make maintaining docs a lot simpler. We can even add a CI check that docs are up-to-date. https://github.com/hashicorp/terraform-plugin-docs

To be able to use the tool we need to Migrate from Legacy Provider Docs, which the tool is supposed to be able to do as well.

SDK Version

No response

API Version

No response

Relevant log output


Code of Conduct

  • [x] I agree to follow this project's Code of Conduct

deiga avatar Dec 03 '25 18:12 deiga