dvc.org icon indicating copy to clipboard operation
dvc.org copied to clipboard

ref: add `dvc` CLI cheatsheet (maybe guide)

Open Suor opened this issue 4 years ago • 0 comments

Cheatsheet is a page with a compact listing of commands or functions. It is usually:

  • divided in sections and subsections by topic, optionally into columns
  • single word for a term
  • short description and signature/options on mouse over
  • link leads to the related documentation page or page with anchor
  • the less screens it fits the better

Purposes are quick navigation, discovery and glanceability. For DVC we already have group of commands, but may either group them further or list subcommands, i.e. plots show/diff/modify, or both.

Here are examples of cheatsheets for funcy python library and Clojure stdlib.

Suor avatar Sep 03 '21 08:09 Suor