API.md Is too large to render on github

[bspates]

Github only allows you to view the Raw version of the readme file. While this is certainly still usable, it hurts my brain...

[JDeBo]

+1 to this. Would be great to see this generated to a static site using something like https://www.mkdocs.org/. Happy to help out if team is running low on resources.

[GonzalezAndrew]

+1 for this. I cannot render/preview the file in vscode or obsidian.md

[josh-stevens]

Yes please. The large md file crashes anything I try to read it with.

[ansgarm]

Hi everyone 👋

We are aware of this and are looking at ways to improve this (probably by splitting the files). In the meantime you could also find the documentation on Construct Hub, as it automatically indexes all CDK construct packages which includes the CDKTF providers: @cdktf/provider-aws on constructs.dev

[xiehan]

This was resolved last week. Every prebuilt provider now has a docs/ folder, e.g. https://github.com/cdktf/cdktf-provider-aws/tree/main/docs, with documentation broken up by language. We're working on an even better long-term solution for provider documentation, but in the meantime, this is a vast improvement over the large API.md files. Kudos to @DanielMSchmidt for his work on this!

[github-actions[bot]]

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.