nix.dev icon indicating copy to clipboard operation
nix.dev copied to clipboard

Proposal for a table overview in `Shell.nix` tutorial

Open VuiMuich opened this issue 2 years ago • 4 comments

As mentioned on reddit IMO it would be nice to have a condened overview as a table at the beginning.

(Draft as this is just a stylistic proposal as discussion basis and eventually should porbably be expanded on all tutorial articles.)

VuiMuich avatar Aug 19 '23 16:08 VuiMuich

I'm generally in support of this, but the exact format could use some bikeshedding since we'd want it to look nice regardless of the length of the content in each part of the table.

zmitchell avatar Aug 19 '23 17:08 zmitchell

As far as I can tell the mark down renderer is responsible for line wrapping the individual cells. Tbh I have no idea if or how it would be possible to enforce a static width of the columns, is this possible in the custom css? I tested with glow to render in the terminal and it automatically to a relative compact table with three lines and with litemdview which offers a very nice responsive result.

VuiMuich avatar Aug 20 '23 09:08 VuiMuich

Also was considering adding the tooltip link to the time itself and changing the clock for an icon more representing "intercativity":

📖 🕹 What will you learn? What will you need?
10 min 30 min How to create and configure reproducible shell environments A basic understanding of the Nix language

VuiMuich avatar Aug 20 '23 10:08 VuiMuich

All in all this could be structured data that one would find a suitable representation for. But we have to make a trade-off with maintainability ease of contributor onboarding, and in that regard I subscribe to a low-tech paradigm. Therefore I would rather keep it as it is, as any new moving part needs explanation of how it works and how to deal with it.

fricklerhandwerk avatar Aug 21 '23 16:08 fricklerhandwerk