The Theseus OS Book

This directory contains Theseus's book-style documentation, which provides an overview of Theseus design principles, implementation choices, and high-level details about its key components.

You can browse the book directly starting at SUMMARY.md, the table of contents and first chapter.

The book is written in Markdown and uses mdBook to build a nicely-formatted HTML version of the book.

Building the book

First, install mdbook, version 0.4.13 or higher:

cargo +stable install mdbook

You can optionally install a plugin that checks links when building the book:

cargo +stable install mdbook-linkcheck

From the top-level directory, you can use make to build and view the book by running:

make view-book

If you have problems installing or using mdbook, try to uninstall it, update Rust, and then reinstall it:

cargo uninstall mdbook
rustup toolchain update stable
cargo +stable install mdbook

Spellcheck

The book source files use cspell for spell checking. cspell can be run through node or as a Visual Studio Code extension. Valid words can be added to the cspell dictionary by adding the word to the words array in the book\cspell.json configuration file. Words to be ignored can be added to the ignoreWords array. Settings that are only applicable to a specific file can be added as inline comments.

See also: Source-level Documentation

For specific details about the source code, e.g., structs, functions, modules, and more, please check out the source-level documentation generated from the inline source code comments by rustdoc.