Skip to content

Further tools refactor - #331

Open
mmesiti wants to merge 4 commits into
coderefinery:mainfrom
mmesiti:further-tools-refactor
Open

mmesiti wants to merge 4 commits into
coderefinery:mainfrom
mmesiti:further-tools-refactor

Conversation

@mmesiti

@mmesiti mmesiti commented Mar 19, 2026 •

Copy link
Copy Markdown
Contributor

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:

  • the table. Does the content of the table make sense? Is it understandable? Do you agree with my ratings about convenience/easiness/maintainability/searchability/readability/LLM friendliness and notes?
  • I removed some text sections as I think that the table is probably enough.
  • I added some key points, there was only one, I think we do have more than a single "take home message".

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).

to be discussed.
The table tries to summarise,
but too much summarisation might just result in
ambiguous/debatable/wrong
statements
@mmesiti
mmesiti force-pushed the further-tools-refactor branch from 3b0b94f to e97ceec Compare March 19, 2026 16:37
@mmesiti
mmesiti marked this pull request as ready for review May 13, 2026 08:23
@wmvanvliet

Copy link
Copy Markdown
Contributor

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?

@mmesiti

mmesiti commented Sep 23, 2026

Copy link
Copy Markdown
Contributor Author

HTML is not readable (in a browser)?

Ops, wft? I think that I swapped the LLM friendliness and readability rows in the list table. Fixing that now

Comment thread content/tools.md Outdated
Comment thread content/tools.md Outdated
Comment thread content/tools.md Outdated
Comment thread content/tools.md Outdated
@bast

bast commented Sep 23, 2026

Copy link
Copy Markdown
Member

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>
@mmesiti
mmesiti force-pushed the further-tools-refactor branch from f6e8cfa to ef2df24 Compare September 23, 2026 16:56
@mmesiti

mmesiti commented Sep 23, 2026

Copy link
Copy Markdown
Contributor Author

It’s the only serious option for API documentation… could that be a column?

I added this in the notes, since a column for this would be quite boring ("all is worthless except static site generators").

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.

I have replaced "Maintainable" by "Maintainable/Reproducible" (and an updated explanation).
I'd like to limit the number of columns, otherwise the table would become sparse and we're still trying to represent it as a dense matrix, and of course having to scroll horizontally is not nice.

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 llms.txt. Not sure if it deserves to be there, though. Also, with the LLM-friendly column might sound like a goofy attempt at looking trendy.

- 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.
@mmesiti
mmesiti force-pushed the further-tools-refactor branch from ef2df24 to 350ce47 Compare September 23, 2026 17:08

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants