mirror of
https://github.com/stoatchat/stoatchat.git
synced 2026-07-14 13:36:59 +00:00
docs: create mdbook
This commit is contained in:
@@ -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
1
doc/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
book
|
||||
6
doc/book.toml
Normal file
6
doc/book.toml
Normal file
@@ -0,0 +1,6 @@
|
||||
[book]
|
||||
authors = []
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "Revolt Backend"
|
||||
7
doc/src/SUMMARY.md
Normal file
7
doc/src/SUMMARY.md
Normal 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
5
doc/src/hello.md
Normal 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!
|
||||
Reference in New Issue
Block a user