build: initial skeleton

Add initial build system integration.

doc/.gitignore

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+# SPDX-License-Identifier: CC0-1.0
+
+/book

doc/CMakeLists.txt

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+# SPDX-License-Identifier: EUPL-1.2
+
+cmake_minimum_required(VERSION 3.30)
+
+include(cmake/helpers)
+
+project(linux-parental-controls-doc
+  LANGUAGES NONE)
+
+ensure_rust_utils(
+  mdbook
+  mdbook-mermaid)
+
+# ------------------------
+
+set(doc_sources
+  src/SUMMARY.md
+
+  src/architectural-overview.md
+  src/design-tenets.md
+  src/why.md
+
+  src/components/nss.md)
+
+# ------------------------
+
+add_custom_target(doc ALL
+  COMMAND ${mdbook} build --dest-dir ${CMAKE_CURRENT_BINARY_DIR}/out ${CMAKE_CURRENT_SOURCE_DIR}
+  DEPENDS ${mdbook} ${mdbook-mermaid} ${doc_sources}
+  VERBATIM
+)
+
+add_custom_target(doc-watch
+  COMMAND ${mdbook} serve --open --dest-dir ${CMAKE_CURRENT_BINARY_DIR}/out ${CMAKE_CURRENT_SOURCE_DIR}
+  DEPENDS ${mdbook} ${doc_sources}
+  VERBATIM
+)

doc/book.toml

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+# SPDX-License-Identifier: CC0-1.0
+
+[book]
+authors = ["Matteo Settenvini"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Linux Parental Controls"
+
+[rust]
+edition = "2024"
+
+[build]
+build-dir = "build"
+
+[preprocessor.mermaid]
+
+[output.html]
+additional-js = ["mermaid.min.js", "mermaid-init.js"]

doc/mermaid-init.js

@@ -0,0 +1,35 @@
+(() => {
+    const darkThemes = ['ayu', 'navy', 'coal'];
+    const lightThemes = ['light', 'rust'];
+
+    const classList = document.getElementsByTagName('html')[0].classList;
+
+    let lastThemeWasLight = true;
+    for (const cssClass of classList) {
+        if (darkThemes.includes(cssClass)) {
+            lastThemeWasLight = false;
+            break;
+        }
+    }
+
+    const theme = lastThemeWasLight ? 'default' : 'dark';
+    mermaid.initialize({ startOnLoad: true, theme });
+
+    // Simplest way to make mermaid re-render the diagrams in the new theme is via refreshing the page
+
+    for (const darkTheme of darkThemes) {
+        document.getElementById(darkTheme).addEventListener('click', () => {
+            if (lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+
+    for (const lightTheme of lightThemes) {
+        document.getElementById(lightTheme).addEventListener('click', () => {
+            if (!lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+})();

doc/mermaid-init.js.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: Knut Sveidqvist
+SPDX-License-Identifier: MIT

doc/mermaid.min.js.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: Knut Sveidqvist
+SPDX-License-Identifier: MIT

doc/src/SUMMARY.md

@@ -0,0 +1,15 @@
+<!--
+SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# Summary
+
+[Why Linux Parental Controls?](./why.md)
+
+- [Design tenets](./design-tenets.md)
+- [Architectural Overview](./architectural-overview.md)
+
+# Components
+
+- [NSS module](./components/nss.md)

doc/src/architectural-overview.md

@@ -0,0 +1,6 @@
+<!--
+SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# Architectural Overview

doc/src/components/nss.md

@@ -0,0 +1,6 @@
+<!--
+SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# NSS Module

doc/src/design-tenets.md

@@ -0,0 +1,6 @@
+<!--
+SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# Design Tenets

doc/src/why.md

@@ -0,0 +1,16 @@
+<!--
+SPDX-FileCopyrightText: Matteo Settenvini <matteo.settenvini@montecristosoftware.eu>
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# Why Linux Parental Controls?
+
+Example:
+
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```