lnnrtwttkhn / version-control-book

Source code for the Version Control Book, a guide to Git for scientists
https://lennartwittkuhn.com/version-control-book/
Creative Commons Attribution Share Alike 4.0 International
7 stars 5 forks source link

Split `cheatsheet.json` into cheatsheet ("examples") and used commands #271

Open lnnrtwttkhn opened 2 months ago

lnnrtwttkhn commented 2 months ago

By now, the cheatsheet contains (1) the commands that are introduced in each chapter (e.g., git branch) and (2) some more concrete examples of those commands (e.g., git branch -d feature). I think it could be useful to differentiate these two aspects and have (1) one list with the "pure" commands that are introduced in the chapter and then (2) concrete examples of those commands. the latter is potentially more useful.

We could do this by either

  1. splitting up cheatsheet.json into two files or
  2. modifying cheatsheet.json such that both aspects can be combined in one .json file

the second approach might be a bit more elegant but requires to adapt the code that generates the cheatsheet.