documentation icon indicating copy to clipboard operation
documentation copied to clipboard

popular tools and solution: possible refactoring

Open mmesiti opened this issue 4 months ago • 2 comments

  • This episode has a lot of text, that although from a "survey of tools" point of view is interesting, it might not be interesting to someone who is looking for a solution in his domain. We could reorganize the "tools" section using tabs (one tab per programming language/ecosystem should work fine here, to keep the attitude "user-centered")
  • In code documentation is discussed anyway in the following episode. This could be moved ahead of this one?

mmesiti avatar Oct 02 '25 08:10 mmesiti

Fully for some reorganization here! I do not know what would be a good way, almost have to see it to say and think.

Also ping to @bast @rkdarst @rantahar @johanhellsvik @ashwinvis @tpfau (earlier instructors and contributors) in case you have any thoughts?

samumantha avatar Oct 06 '25 14:10 samumantha

Further thoughts: there are somethings that "scream" (perhaps only to me) to be included somehow, for example

  • semantic line breaks
  • the importance of the search feature (and sphinx seems to have been, historically, pretty bad at that compared to alternatives)
  • LLM-friendliness of different documentation formats (README.md very friendly, a collection of html pages perhaps not so friendly, but this statement perhaps was true 5 months ago and it's not true any more). RAG-friendliness? For how long will this be relevant?

mmesiti avatar Oct 06 '25 15:10 mmesiti