The README.md can actually be a reserved space for human beings to read with whatever the author thinks is most important to communicate to the human operator.
Whether that's effective is another matter, even if the LLM generating the list does so correctly and updates the list consistently
This is just yet another low-effort slop specimen.
I've been a travelling developer at military for security services for more than two decades now, and there's not a single soul out there I know in person who would expect or claim that any documentation is not for people but machines exclusively or initially even.
A documentation, whether formatted/standardized/conventional or not, is for a human, and always will be, because this is what you leave in the history of your own work of life.
> You can add a README file to your repository to tell other __people__ why your project is useful, what they can do with your project, and how they can use it.
>
> Source: https://github.com/github/docs/blob/9af628699ba0d381fb04929a6384c70d63cef8b9/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.mdCoke Zero is good these days.
If we are splitting hairs some sections could have been left out or broken up into a dedicated doc, but this is still vastly better than a README that explains too little. At minimum I expect a README to give me guidance on what this is and how to get started with it and having stuff like a file layout helps with exactly that.
- https://github.com/Sessa93/remote-df/commit/15bae297e5cad187...
Let's hope they wrote it manually, or at least re-verified the possibly re-generated "simplified" version...
The minute I see them, I tune out and move on. These types of docs come across to me as so over-specified and memorialized that I just find it not worth the effort to read. Of course for legacy projects this type of documentation would have been invaluable. What's changed, I wonder?