Skip to content

Commit 58dfa16

Browse files
committed
Removes obsolete help files and adds new documentation files to improve the structure and organization of the Fire Framework project.
1 parent 2c9e1c5 commit 58dfa16

File tree

12 files changed

+58
-3
lines changed

12 files changed

+58
-3
lines changed

docs/guide/app.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 1
3+
---

docs/guide/cli tool.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 8
3+
---

docs/guide/controller.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 4
3+
---

docs/guide/handler.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 6
3+
---

docs/guide/helpers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 7
3+
---

docs/guide/installation.md

Whitespace-only changes.

docs/guide/introduction.md

Whitespace-only changes.

docs/guide/middleware.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 3
3+
---

docs/guide/model.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Models, Migrations, and Database Abstraction
6+
7+
:::danger Important
8+
For the model, we decided to use **Eloquent**, Laravel's powerful and elegant ORM, to simplify database interactions and improve productivity.
9+
10+
Learn more about Eloquent in the [**official Laravel documentation**](https://laravel.com/docs/12.x/eloquent).
11+
:::
12+
13+
We have designed an interface named `IDatabaseManager` to provide flexibility and extensibility for managing database operations. Below are the two core methods it defines:
14+
15+
```php
16+
/**
17+
* Configure the database manager with the given configuration.
18+
*
19+
* @param array $config The configuration array.
20+
* @return void
21+
*/
22+
public function configure(array $config): void;
23+
```
24+
25+
```php
26+
/**
27+
* Boot the database manager, establishing connections and preparing for use.
28+
*
29+
* @return void
30+
*/
31+
public function boot(): void;
32+
```
33+
34+
By implementing this interface, you can customize and enhance the database management process to suit your application's specific needs. Additionally, it allows for seamless switching to a different database manager if required, providing flexibility and adaptability for your project.

docs/guide/router.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_position: 2
3+
---

0 commit comments

Comments
 (0)