Overview

Where the Documentation is Stored and Hosted

The documentation is all stored in a Github repository. When a change is pushed to the repository, it automatically triggers the book to be rebuilt and updated.

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.

Previous Version of the Documentation

Previous, in the daffy version, the documentation was split amongst several books. With the ente version and beyond, the documentation is merged into one monolithic book that can be searched and indexed more easily.

The “version” of the documentation corresponds to the branch in the repository. 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.

Future versions of the documentation will be new branches of this repository.

Deprecated Documentation System

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