feat(#153): Added documentation & structure (#1)

* Removed content

* Added User Guide content

* Added Testing Guide content

* Added SQLite DB Guide content

* Added 404 page

* Added Introduction page

* Added summary & toml file

* Added gitignore

* Cleanup

Author: Hiccup-za

.gitignore

@@ -0,0 +1 @@
+book

book.toml

@@ -1,14 +1,16 @@
 [book]
-title = "Njord - A lightweight ORM library in Rust"
-authors = ["Marcus Cvjeticanin"]
+authors = ["Marcus Cvjeticanin", "Christopher Zeuch"]
+title = "Njord"
 description = "A lightweight ORM library in Rust with strong-typed SQL DSL and sequence API."
 language = "en"
-git-repository-url = "https://github.com/mjovanc/njord"
+multilingual = false
+git-repository-url = "https://github.com/njord-rs/docs"
 git-repository-icon = "fa-github"
-copy-fonts = true
-edit-url-template = "https://github.com/mjovanc/njord/tree/docs/src/{path}"
-cname = "njord.rs"
-input-404 = "not-found.md"
+src = "src"
+input-404 = "404.md"
+
+[output.html]
+copy-code = true
 
 [build]
-target-dir = "book"
+target-dir = "book"

docs/CNAME

@@ -0,0 +1,3 @@
+# 😵 404
+
+The page you are looking for does not exist.

docs/src/README.md

@@ -0,0 +1,37 @@
+# Introduction
+
+A lightweight ORM library in Rust with strong-typed SQL DSL and sequence API.
+
+We support the following databases:
+
+| Database   | Support   |
+| ---------- | :-------: |
+| SQLite     | ✅        |
+| PostgreSQL | ❌        |
+| MySQL      | ❌        |
+| MariaDB    | ❌        |
+| Oracle     | ❌        |
+| MSSQL      | ❌        |
+
+## ✨ Contributors
+
+We'd like to take a moment to recognize our awesome contributors:
+
+[<img src="https://github.com/mjovanc.png?size=72" alt="mjovanc" width="72">](https://github.com/mjovanc)
+[<img src="https://github.com/appelskrutt34.png?size=72" alt="appelskrutt34" width="72">](https://github.com/appelskrutt34)
+[<img src="https://avatars.githubusercontent.com/u/23294573?v=4&size=72">](https://github.com/ahsentekd)
+[<img src="https://avatars.githubusercontent.com/u/167654108?v=4&size=72">](https://github.com/chinmer)
+[<img src="https://github.com/SvMak.png?size=72" alt="SvMak" width="72">](https://github.com/SvMak) 
+[<img src="https://github.com/TomasWild.png?size=72" alt="TomasWild" width="72">](https://github.com/TomasWild) 
+[<img src="https://github.com/chaseWillden.png?size=72" alt="chaseWillden" width="72">](https://github.com/chaseWillden) 
+[<img src="https://github.com/Hiccup-za.png?size=72" alt="Hiccup-za" width="72">](https://github.com/Hiccup-za)
+
+## 🤝 Contributing
+
+Help us implement support for these databases and more!
+
+Please first talk to us in [Discord](https://discord.gg/AbK57nAGv8) about what you are planning to do so we both save time and effort. If it's only bug fixes or documentation, feel free to submit a PR.
+
+## 📄 License
+
+The BSD 3-Clause License.

docs/src/SUMMARY.md

@@ -0,0 +1,21 @@
+# Summary
+
+[Introduction](README.md)
+
+# ⚡️ Getting Started
+- [Installation](user-guides/installation.md)
+- [Add a schema file](user-guides/add-schema.md)
+
+# 📚 Database Guides
+- [SQLite](db-guides/sqlite/sqlite.md)
+    - [Connection](db-guides/sqlite/connection.md)
+    - [Initialize a database](db-guides/sqlite/initialize-database-with-tables.md)
+    - [Define Tables](db-guides/sqlite/define-tables.md)
+    - [Insert](db-guides/sqlite/insert.md)
+    - [Select](db-guides/sqlite/select.md)
+    - [Drop](db-guides/sqlite/drop.md)
+
+# 🧪 Testing Guides
+- [Test Structure](testing-guides/test-structure.md)
+- [Running Tests](testing-guides/running-tests.md)
+- [Adding New Tests](testing-guides/adding-new-tests.md)

docs/src/not-found.md

@@ -0,0 +1 @@
+# 📚 Database Guides

docs/src/sqlite/sqlite.md

@@ -0,0 +1,173 @@
+# SQlite
+
+## Establish a connection
+
+To establish a connection we first need to call the `sqlite::open()` function and use it with a match statement.
+
+```rust
+let db_name = "njord.db";
+let db_path = Path::new(&db_name);
+
+match sqlite::open(db_path) {
+    Ok(c) => {
+        println!("Database opened successfully!");
+        
+        // Additional logic when we are connected.
+        // We need to open a connection and pass it 
+        // to the corresponding sqlite function.
+    }
+    Err(err) => eprintln!("Error opening the database: {}", err),
+}
+```
+
+## Insert data
+
+```rust
+let user = User {
+    id: AutoIncrementPrimaryKey::default(),
+    username: String::from("john_doe"),
+    email: String::from("[email protected]"),
+    address: String::from("123 Main St"),
+};
+
+let result = sqlite::insert(c, vec![user]);
+assert!(result.is_ok());
+```
+
+**Generated SQL**
+
+```sql
+INSERT INTO users (
+    username,
+    email,
+    address
+) VALUES (
+    'john_doe',
+    '[email protected]',
+    '123 Main St'
+)
+```
+
+## Update data
+
+```rust
+let columns = vec!["username".to_string(), "address".to_string()];
+let where_condition = Condition::Eq("username".to_string(), "john_doe".to_string());
+
+let user = User {
+    id: AutoIncrementPrimaryKey::<usize>::new(Some(0)),
+    username: String::from("john_doe_2"),
+    email: String::from("[email protected]"),
+    address: String::from("1234 Main St"),
+};
+
+let mut order = HashMap::new();
+order.insert(vec!["id".to_string()], "DESC".to_string());
+        
+let result = sqlite::update(c, user)
+    .set(columns)
+    .where_clause(where_condition)
+    .order_by(order)
+    .limit(4)
+    .offset(0)
+    .build();
+
+assert!(result.is_ok());
+```
+
+**Generated SQL**
+
+```sql
+UPDATE users
+SET
+    username
+WHERE
+    username = 'john_doe'
+ORDER BY
+    id DESC
+LIMIT 4
+OFFSET 0
+
+```
+
+## Delete data
+
+```rust
+let where_condition = Condition::Eq("username".to_string(), "john_doe".to_string());
+
+let mut order = HashMap::new();
+order.insert(vec!["id".to_string()], "DESC".to_string());
+
+let result = sqlite::delete(c)
+    .from(User::default())
+    .where_clause(where_condition)
+    .order_by(order)
+    .limit(20)
+    .offset(0)
+    .build();
+
+assert!(result.is_ok());
+```
+
+**Generated SQL**
+
+```sql
+DELETE FROM users
+WHERE
+    username = 'john_doe'
+ORDER BY
+    id DESC
+LIMIT 20
+OFFSET 0
+```
+
+## Select data
+
+```rust
+let columns = vec!["id".to_string(), "username".to_string(), "email".to_string(), "address".to_string()];
+let where_condition = Condition::Eq("username".to_string(), "john_doe".to_string());
+let group_by = vec!["username".to_string(), "address".to_string()];
+
+let mut order_by = HashMap::new();
+order_by.insert(vec!["id".to_string()], "ASC".to_string());
+
+let having_condition = Condition::Gt("id".to_string(), "1".to_string());
+
+// Build the query
+// We need to pass the struct User with the Default trait in .from()
+let result: Result<Vec<User>> = sqlite::select(c, columns)
+    .from(User::default())
+    .where_clause(where_condition)
+    .order_by(order_by)
+    .group_by(group_by)
+    .having(having_condition)
+    .build();
+
+match result {
+    Ok(result) => {
+        assert_eq!(result.len(), 1);
+    }
+    Err(error) => panic!("Failed to SELECT: {:?}", error),
+};
+```
+
+**Generated SQL**
+
+```sql
+SELECT
+    id,
+    username,
+    email,
+    address
+FROM
+    users
+WHERE
+    username = 'mjovanc'
+GROUP BY
+    username,
+    email
+HAVING
+    id > 1
+ORDER BY
+    email DESC
+```

src/404.md

@@ -0,0 +1,46 @@
+# Adding New Tests
+
+To add new tests to Njord:
+
+1. Create a new folder in the `tests` directory if it doesn't exist.
+2. Add a `mod.rs` file to declare submodules and shared utilities.
+3. Create test files (e.g., `test_1.rs`, `test_2.rs`) within the folder.
+
+For example, to add tests for a new feature called "user_management":
+
+```
+njord/
+└── tests/
+    └── user_management/
+        ├── mod.rs
+        ├── create_user.rs
+        └── delete_user.rs
+```
+
+In the `mod.rs` file, declare the test files as modules:
+
+```rust
+mod create_user;
+mod delete_user;
+```
+
+Write your test functions in `create_user.rs` and `delete_user.rs` using the `#[test]` attribute.
+
+This structure allows you to:
+- Group related tests together
+- Share common setup and utilities across tests in the same module
+- Easily run all tests for a specific feature
+
+Remember to use descriptive names for your test functions and keep tests isolated and independent of each other.
+
+---
+
+## Best Practices
+
+1. Group related tests in the same module (folder).
+2. Use descriptive names for test functions.
+3. Keep tests isolated and independent of each other.
+4. Use setup and teardown functions in `mod.rs` for common operations.
+5. Run tests frequently during development to catch issues early.
+
+By following this structure and these practices, you can maintain a clean and efficient testing suite for Njord.

src/README.md

@@ -0,0 +1,21 @@
+## Running Tests
+
+Now that we understand the structure, let's look at how to run tests.  
+Rust's test runner is built into the `cargo` command and provides several options:
+
+1. Run all tests in the project:
+   ```bash
+   cargo test
+   ```
+
+2. Run tests in a specific module (folder):
+   ```bash
+   cargo test --test folder_1_tests
+   ```
+   This command runs all tests in the `folder_1` module, as defined by its `mod.rs` file.
+
+3. Run a specific test function:
+   ```bash
+   cargo test --test folder_1_tests test_function_name
+   ```
+   This runs a specific test function within the `folder_1` module.