diff --git a/default.nix b/default.nix index 74e22096..0ff5a314 100644 --- a/default.nix +++ b/default.nix @@ -31,6 +31,9 @@ in pkgs.mkShell { pkgs.rustfmt pkgs.pkgconfig pkgs.openssl.dev + + # mdbook + pkgs.mdbook ]; RUST_SRC_PATH = "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}"; diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000..7585238e --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +book diff --git a/doc/book.toml b/doc/book.toml new file mode 100644 index 00000000..5ef489b5 --- /dev/null +++ b/doc/book.toml @@ -0,0 +1,6 @@ +[book] +authors = [] +language = "en" +multilingual = false +src = "src" +title = "Revolt Backend" diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md new file mode 100644 index 00000000..1b15bc68 --- /dev/null +++ b/doc/src/SUMMARY.md @@ -0,0 +1,7 @@ +# Summary + +- [Introduction](./hello.md) +- [Project Structure]() +- [Testing]() + - [Writing a new database test]() + - [Writing a new API test]() diff --git a/doc/src/hello.md b/doc/src/hello.md new file mode 100644 index 00000000..f8182679 --- /dev/null +++ b/doc/src/hello.md @@ -0,0 +1,5 @@ +# Revolt Backend + +Welcome to the developer documentation for the Revolt backend. + +This is very much incomplete and needs more work!