terraform-cdk icon indicating copy to clipboard operation
terraform-cdk copied to clipboard

API Reference Docs: Python API docs cause my browser to hang on less powerful machines

Open josh-thisisbud opened this issue 2 years ago • 2 comments

Description

Whenever I'm attempting to load the Python API reference pages for Terraform CDK, I experience long periods of the page struggling to load and very poor performance in Chrome.

I believe that this is partly due to the length of the generated content and would like to suggest that the individual sections were split into sub pages with cross-referencing links.

Links

https://developer.hashicorp.com/terraform/cdktf/api-reference/python

Help Wanted

  • [ ] I'm interested in contributing a fix myself

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment

josh-thisisbud avatar Jul 07 '23 15:07 josh-thisisbud

Hi @josh-thisisbud 👋

We agree this should be addressed! Unfortunately it's not something we'll have capacity to work on soon, but we welcome any community contributions.

ansgarm avatar Jul 14 '23 13:07 ansgarm

Agree with this. Maybe it could be better to separate pages for each subtitles (Constructs/Structs/Classes...) into subpages 👀

kination avatar Jul 17 '23 03:07 kination