Overview#

Where the documentation is#

The documentation is broken down into a collection of books, with each book contained in a separate repository called book-[name]:

For example:

Documentation format#

The documentation is written as a series of small files in Markedly Structured Text (MyST), a Markdown format inspired by Sphinx and reStructuredText (RST).

It is then processed by a series of scripts to create publication-quality PDF and an online HTML version.

You can find all these artifacts produced at the site https://docs.duckietown.com.

Documentation branches#

Each book repository has several branches. In particular, the daffy branch includes documentation related to the daffy Duckietown software distribution. The ente branch describes the ente version of Duckietown software distribution, and it is substantially different from the older daffy version.

Daffy documentation can be found at https://docs.duckietown.com/daffy, and the respective content available on the Duckietown GitHub, in repositories named docs-[book name], e.g., the Old Duckiebot operation manual.

Ente documentation can be found at https://docs.duckietown.com/ente.

Deprecated documentation system#

The older, now deprecated, Duckietown documentation system is available at: https://docs-old.duckietown.org/daffy/.