tutorial icon indicating copy to clipboard operation
tutorial copied to clipboard

Please add some help for reading documentation

Open shaib opened this issue 6 years ago • 1 comments

Issue description

The Introduction to the command-line interface chapter includes a section instructing the user to learn more about the command by asking for its documentation. On Windows, this is cd /?. The output of this command starts with this (up to minor variations per Windows version):

C:\Users\Shai>cd /?
Displays the name of or changes the current directory.

CHDIR [/D] [drive:][path]
CHDIR [..]
CD [/D] [drive:][path]
CD [..]

  ..   Specifies that you want to change to the parent directory.

When I was going through this with a youth who has been using computers a lot (and even dabbled with some Python) but really needed this chapter -- the command line is completely new to her -- this looked very daunting. I had to explain what the square brackets mean, what the drives are, and even what's a parent directory.

I don't think everything needs to be explained here, but at least some syntax (like brackets) should be, and perhaps a reference to fuller explanations about the file-system; and most importantly, a disclaimer along the lines of "don't worry if not all seems clear now, it will become clearer as you move along".

Language

I haven't checked translations, but I believe English is the source...

Operating system

Windows is much scarier than Unix in this regard, because the Unix manuals have headings ("Name", "Synopsys", "Descriptions") which Windows help files lack.

shaib avatar Aug 27 '19 10:08 shaib

:thinking: Can we just combine the "don't worry if not all seems clear now, it will become clearer as you move along" disclaimer with a link to preexisting more in-depth material on the topic and be done with it? A(nother) lengthy explanation might make the tutorial itself more daunting.

das-g avatar Aug 27 '19 15:08 das-g