Conversation
to be discussed. The table tries to summarise, but too much summarisation might just result in ambiguous/debatable/wrong statements
3b0b94f to
e97ceec
Compare
|
Good idea to have a table there. Html generators look like a bad choice in the table. HTML is not readable (in a browser)? It’s the only serious option for API documentation… could that be a column? |
Ops, wft? I think that I swapped the LLM friendliness and readability rows in the list table. Fixing that now |
|
This is great! In the table I am missing a column "reproducible" (might be covered by "maintainable" but is not immediately clear for me as reader), meaning: How easy it is to serve or at least re-create documentation from a past version of the code project. This is very important for larger codes where many users might not be running the latest version always. Wikis that are often disconnected from the code version history are traditionally very bad at this kind of reproduciblity. |
Co-authored-by: Michele Mesiti <mmesiti@users.noreply.github.com> Co-authored-by: Radovan Bast <bast@users.noreply.github.com>
f6e8cfa to
ef2df24
Compare
I added this in the notes, since a column for this would be quite boring ("all is worthless except static site generators").
I have replaced "Maintainable" by "Maintainable/Reproducible" (and an updated explanation). On the same note, I merged the Convenient / Easy columns (adding some caveats), probably the distinction between the two is too subtle to warrant so much space. Also, added |
- merge Convenience and Easiness columns, added some notes regarding that - Maintainable -> Maintainable/Reproducible, updated explanation - Some tweaks to make columns slimmer - add comment about HTML generators being the only technique that allows readable API documentation - add llms.txt row Also fix sentence in HTML generator section about API reference.
ef2df24 to
350ce47
Compare
View the result: https://mmesiti.github.io/cr-documentation/branch/further-tools-refactor/tools/
Further changes to "popular tools and solutions", to be discussed with calm later.
(building on top of the other #330 PR)
Update 13.05.2026:
Feedback needed on:
Marking as ready not because it's ready to be merged but to signal it is ready for review.
(and thanks sphinx-lesson and github actions for rendering all the branches).