Documentation Structure

Markdown sources

The documentation is a static Website generated from Markdown files using mdBook.

The documentation resources are part of the SparkleMuffin repository, and located under the docs/ directory:

docs/
├── book       # Generated Website (not tracked in Git)
├── book.toml  # mdBook configuration
└── src        # Markdown source files

Sections and page categories

There are two main sections:

  • a User Guide that showcases SparkleMuffin's features and how to use them;
  • a Developer Guide that provides information on how SparkleMuffin works, and how to contribute to the project.

Pages are organized into four categories, according to the Diátaxis approach:

  • Tutorials: learning-oriented lessons that take you through a series of steps to use a feature;
  • How-to Guides: practical step-by-step guides to help you achieve a specific goal;
  • Reference Guides: details about how SparkleMuffin works;
  • Concept Guides: thoughts and reflections about how why things work the way they do.

Reference