4 ms·

I don't have much to add other than to compliment the README. At least it shows some concern about documenting the higher level architecture... I get discourage

I don't have much to add other than to compliment the README. At least it shows some concern about documenting the higher level architecture... I get discouraged of contributing to open source due to the laziness of basically having to reverse engineer the code

dharmit 2y ago
Came here to appreciate the "Project Structure" section - https://github.com/andrearaponi/dito?tab=readme-ov-file#project-structure https://github.com/andrearaponi/dito?tab=readme-ov-file#proj.... Very few projects care about it, as far as I have seen.
- ignoramous 2y ago
  LLMs are quite capable at generating such overviews. mutable.ai generated one for a project I co-develop, and it was pretty neat for a v1 (they are on a much improved v2 now): https://mutable.ai/celzero/firestack https://mutable.ai/celzero/firestack
cybrox 2y ago
This used to be pretty standard but has largely gone away, unfortunately. I blame frameworks that encourage the user to just use their "obvious" specific directory structure that works for 80% but people still make up the other 20% And no need for documentation, since is "obvious" [...to anyone who has invested dozens of hours working with that specific framework]