docs: create mdbook

This commit is contained in:
Paul Makles
2024-05-11 17:42:08 +01:00
parent 7703475868
commit b3494b12fc
5 changed files with 22 additions and 0 deletions

View File

@@ -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}";

1
doc/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
book

6
doc/book.toml Normal file
View File

@@ -0,0 +1,6 @@
[book]
authors = []
language = "en"
multilingual = false
src = "src"
title = "Revolt Backend"

7
doc/src/SUMMARY.md Normal file
View File

@@ -0,0 +1,7 @@
# Summary
- [Introduction](./hello.md)
- [Project Structure]()
- [Testing]()
- [Writing a new database test]()
- [Writing a new API test]()

5
doc/src/hello.md Normal file
View File

@@ -0,0 +1,5 @@
# Revolt Backend
Welcome to the developer documentation for the Revolt backend.
This is very much incomplete and needs more work!