Skip to content

Improve the documentation

This tool has a lot of potential, but I am afraid adoption is slow as the user experience / documentation isn't easy enough to digest yet. Some suggestions on how to improve docs were posted on the mailing list:

@tachi in https://lists.debian.org/debian-go/2025/09/msg00035.html:

I think these READMEs are missing an easy to understand explanation about what this is, what it does, and why we want it. I have no idea what "OpenTofu" is; I honestly don't care that much right now.

I know this is all pretty lit in the devops space but keep in mind that not everyone is as interested in devops like you are!

As others have said, the readme screams complexity everywhere I look. It may not be all that complex after all, but that's my impression after having looked at it a bit :)

@nilesh in https://lists.debian.org/debian-go/2025/09/msg00033.html:

Also, just a suggestion: it would help if you describe the features first and how it works later in the readme. I ended up reading a bit of documentation about opentofu which probably wasn't needed, but it never hurts to read more :P

And a couple of example commits (in the readme) on how to enable it (on example packages) could be helpful.