this post was submitted on 04 Dec 2025
191 points (99.5% liked)
Programming
24072 readers
343 users here now
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities !webdev@programming.dev
founded 2 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
My favorite is when it generates a tree of the files in a directory in a README and a description for each file. How the fuck is this useful? Files will be added and removed, so there's now an additional task to update these docs whenever that happens. Nobody will remember to do so because no tool is going to enforce that and it's stupid anyway.
Sure, document high level directories. But do you really need that all in the top level README?
Nothing to add. Just quoting this section because it needs to be highlighted lol.