1 | FAQ on Documentation
|
2 | ====================
|
3 |
|
4 | Start here if you can't find something!
|
5 |
|
6 | <div id="toc">
|
7 | </div>
|
8 |
|
9 | ## How are the docs organized?
|
10 |
|
11 | Every release is published at [/release/$VERSION/](../index.html). As of 2024,
|
12 | it links to 2 starting points:
|
13 |
|
14 | 1. [**Published Docs**](published.html) shows docs that are ready to read.
|
15 | Examples:
|
16 | - [Simple Word Evaluation in Unix Shell](simple-word-eval.html)
|
17 | - [YSH Fixes Shell's Error Handling](error-handling.html)
|
18 | 1. [**All Docs**](index.html) shows all docs.
|
19 |
|
20 | The **Oils Reference** at [/release/$VERSION/doc/ref/](ref/index.html) is still
|
21 | in progress.
|
22 |
|
23 | Outside of the release tree:
|
24 |
|
25 | - [The blog](https://www.oilshell.org/blog/) has useful background info. Older
|
26 | posts are more likely to have incorrect information.
|
27 | - [The home page](https://www.oilshell.org/) has links to docs for new users.
|
28 |
|
29 | ## Where do I find ...
|
30 |
|
31 | ### A list of all shell builtins?
|
32 |
|
33 | See the [Chapter on Builtin Commands](ref/chap-builtin-cmd.html) in the reference.
|
34 |
|
35 | ### A list of all YSH functions?
|
36 |
|
37 | See the [Chapter on Builtin Functions](ref/chap-builtin-func.html) in the reference.
|
38 |
|
39 | ### A list of all operators?
|
40 |
|
41 | They are split between the "sublanguages" of OSH and YSH:
|
42 |
|
43 | - [Expression Language](ref/chap-expr-lang.html) for the YSH expression
|
44 | language
|
45 | - [Word Language](ref/chap-word-lang.html) for `${x}` and so forth
|
46 | - [Mini Languages](ref/chap-mini-lang.html) for other shell sublanguages.
|
47 |
|
48 | ## I still can't find what I'm looking for.
|
49 |
|
50 | Please send feedback on Github or Zulip: [Where To Send
|
51 | Feedback](https://github.com/oilshell/oil/wiki/Where-To-Send-Feedback).
|