lib_humus/doc/mod.rs
1// SPDX-FileCopyrightText: 2026 Slatian <baschdel@disroot.org>
2//
3// SPDX-License-Identifier: AGPL-3.0-or-later
4
5//! Documentation module
6//!
7//! ## In here
8//!
9//! In here you can find documentation on:
10//! * [The Template Directory Layout][template_directory]
11//! * [A migration guide to version 0.6](migrating_to_0_6)
12//! * The Configuration files:
13//! * [`templates.toml` the Templates Manifest][templates_manifest]
14//! * [`languages/manifest.toml` the Language Manifest][language_manifest]
15//! * `extra.toml` is fully defined by the template, it is not documented here
16//! * [A reference for writing templates][writing_templates]
17//! * [A guide for developers on how to make the lib-humus parts of your application enjoyable for admins][admin_experience]
18//!
19//! ## See Also
20//!
21//! Example code can be found in the [`lib-humus` repository in the `examples` directory](https://codeberg.org/slatian/lib-humus/src/branch/main/examples).
22//!
23//! * [Documentation for the tera templating engine](https://keats.github.io/tera/)
24//! * [Fluent (the `.flt` files) Website with documentation](https://projectfluent.org/)
25
26pub mod admin_experience;
27pub mod language_manifest;
28pub mod migrating_to_0_6;
29pub mod template_directory;
30pub mod templates_manifest;
31pub mod writing_templates;