Warning: Work in progress! Leave feedback on Zulip or Github if you'd like this doc to be updated.

FAQ on Documentation

Start here if you can't find something!

Table of Contents
How are the docs organized?
Where do I find ...
A list of all shell builtins?
A list of all Oil funcs?
A list of all operators?
I still can't find what I'm looking for.

How are the docs organized?

While we write the documentation, there are two different starting points:

  1. /release/$VERSION/ lists the docs that are ready to read, right below the downloads.
  2. /release/$VERSION/doc/ is a tour through all docs, some of which are in progress.

There's also an incomplete reference, separated by compatible features and new features:

And there are various design docs, like:

Outside of /release/$VERSION/:

Where do I find ...

A list of all shell builtins?

Right now it's split between the OSH and Oil references.

A list of all Oil funcs?

A list of all operators?

They are split between the "sublanguages" of OSH and Oil:

I still can't find what I'm looking for.

Please send feedback on Github or Zulip: Where To Send Feedback.


Generated on Wed May 3 15:38:09 EDT 2023