nushell / nushell.github.io

Nushell's main website, blog, book, and more
https://www.nushell.sh/book/
MIT License
183 stars 425 forks source link

Missing documentation content #500

Open th-schall opened 2 years ago

th-schall commented 2 years ago

I have discovered nu shell some weeks ago and have switched quickly so that it is now my standard shell on Windows and the default profile in Windows Terminal. However, there are some issues I perceive with the documentation. Maybe some or all are to blame to the fact that I am not that familiar with nu shell and its documentation yet. I present all topics anyway, so that this maybe can be resolved by just providing some remark or link.

  1. I assume there are functionalites present in nu shell about which I have not found out anything yet. I cannot tell how to use this at the moment:
  1. A cheat sheet type page which is a command listing/reference organized by topic/usage area. I attached a Markdown link list sketching the idea. I use this link list for myself regularly. nu Shell Cheat Sheet.md

  2. A scripting guide showing best practies and how to create complete non-trivial working scripts using specific tasks like these (among others):

I figure the cookbook wants to address questions like these to some degree, but for my way of thinking the solutions there are too small, isolated without a context of using them in a script. I would look for something more comprehensive. For illustration I attached the very first two scripts I wrote for nu shell as a zip file. script.zip

fdncred commented 2 years ago

I guess this is our cheat sheet https://www.nushell.sh/book/command_reference.html

th-schall commented 2 years ago

I know this list and I use it, but it is not that useful for newbies. You have to know quite specifically, what you are looking for and there is almost no way to identify related commands except for searching for some terms in the text. However, if you are searching for a term uncommon in the nu shell context you probably find nothing. This can happen easily, especially in these cases where nu shell names stuff differently than other shells. So yeah, the basics are there, but I see too little assistance in reaching some decent mastery of nu shell. I wanted to share this perception. Probably just my view, so if you cannot relate to it, just close the issue.

fdncred commented 2 years ago

I know this list and I use it, but it is not that useful for newbies. You have to know quite specifically, what you are looking for and there is almost no way to identify related commands except for searching for some terms in the text. However, if you are searching for a term uncommon in the nu shell context you probably find nothing. This can happen easily, especially in these cases where nu shell names stuff differently than other shells. So yeah, the basics are there, but I see too little assistance in reaching some decent mastery of nu shell. I wanted to share this perception. Probably just my view, so if you cannot relate to it, just close the issue.

I tend to agree with most of this.

I like your cheat sheet. I can see that being a page in the book.