Introduce documentation in docs-folder

README.md

@@ -19,15 +19,24 @@ The official and easy to use **BigBlueButton API for PHP**, makes easy for devel
 [![PHP 8.2](https://img.shields.io/badge/php-8.2-9c9.svg?style=flat-square)](https://www.php.net/supported-versions.php)
 [![PHP 8.3](https://img.shields.io/badge/php-8.3-9c9.svg?style=flat-square)](https://www.php.net/supported-versions.php)
 
-## Installation and usage
+## Installation and Usage
 
-The [wiki] contains all the documentation related to the PHP library. We have also written a samples to show a full
-install and usage example.
+Please see the [documentation](./docs/Home.md) to know how to install and use this PHP-Client to interact with the API of a BigBlueButton-Server.
 
 ## Submitting bugs and feature requests
 
 Bugs and feature request are tracked on [GitHub](https://github.com/bigbluebutton/bigbluebutton-api-php/issues)
 
+## Build the documentation
+
+To build the documentation you need to install `Rust` and `mdbook`
+
+```bash
+curl https://sh.rustup.rs -sSf | sh -s -- -y
+source "$HOME/.cargo/env"
+cargo install mdbook
+```
+
 ## Contributing guidelines
 ### Code Quality 1: Style
 
@@ -61,7 +70,7 @@ For every implemented feature add unit tests and check all is green by running t
 $ composer code-test
 
 # or the same w/o alias
-./vendor/bin/phpunit
+$ ./vendor/bin/phpunit
 ```
 
 To run a single test
@@ -71,7 +80,7 @@ To run a single test
 $ composer code-test -- --filter BigBlueButtonTest::testApiVersion
 
 # or the same w/o alias
-./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion
+$ ./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion
 ```
 A code-coverage report will be created along with the tests. This report will be stored in:
 ````
@@ -86,11 +95,11 @@ $ composer code-test -- --no-coverage
 
 **Remark:**
 
-Some test will connect to an existing BBB-server, which is specified in the `.env`-file. You 
-can specify your own BBB-server by copy that file into the same folder and name it `.env.local`.
-Exchange the credentials `BBB_SERVER_BASE_URL` and `BBB_SECRET` to your server's values.
-Since this new file (`.env.local`) takes precedence over the main file (`.env`), you will now test 
-with your own server.
+Some tests will connect to an existing BBB server, which is specified in the `.env` file. You 
+can specify your own BBB server by making a copy of the `.env` file into the same folder and naming it `.env.local`.
+Replace the credentials for `BBB_SERVER_BASE_URL` and `BBB_SECRET` with your server's values. 
+Since this new file (`.env.local`) takes precedence over the main file (`.env`), you will now run
+the tests on your own server.
 
 ### Automated checks while commiting a change
 To ensure code quality, a took called [CaptainHook](https://github.com/captainhookphp/captainhook?tab=readme-ov-file) will be launched when you are commiting a change and will intercept the commit, if the quality is not as expected. Once the quality of the code is improved the code can be commited (CaptainHook will check again).

docs/.gitignore

@@ -0,0 +1,2 @@
+book
+bin

docs/book.toml

@@ -0,0 +1,40 @@
+[book]
+title = "BigBlueButton PHP API Library - Documentation"
+description = "BigBlueButton PHP API Library - Documentation"
+authors = ["Ghazi Triki", "Tim Korn"]
+language = "en"
+multilingual = false
+src = "src"
+
+[build]
+create-missing = false   # whether or not to create missing pages
+
+# Activate extensions (preprocessors)
+[preprocessor.index]
+[preprocessor.external-links]
+[preprocessor.alerts]
+
+[output.html]
+default-theme = "light"
+preferred-dark-theme = "navy"
+additional-css = ["theme/bbb.css"]
+
+[output.html.search]
+enable = true            # enables the search feature
+limit-results = 25       # maximum number of search results
+teaser-word-count = 30   # number of words used for a search result teaser
+use-boolean-and = true   # multiple search terms must all match
+boost-title = 2          # ranking boost factor for matches in headers
+boost-hierarchy = 1      # ranking boost factor for matches in page names
+boost-paragraph = 1      # ranking boost factor for matches in text
+expand = true            # partial words will match longer terms
+heading-split-level = 3  # link results to heading levels
+copy-js = true           # include Javascript code for search
+
+[output.html.print]
+enable = true     # include support for printable output
+page-break = true # insert page-break after each chapter
+
+[output.html.fold]
+enable = false    # whether or not to enable section folding
+level = 0         # the depth to start folding

docs/src/SUMMARY.md

@@ -0,0 +1,23 @@
+# Summary
+
+# BigBlueButton PHP API
+- [General]()
+  - [Welcome](./general/home.md)
+  - [Getting Started](./general/getting_started.md)
+
+- [Executing API Calls]()
+  - [Meetings](./api_calls/meetings.md)
+  - [Recordings](./api_calls/recordings.md)
+  - [Hooks](./api_calls/hooks.md)
+  - [Server Configuration](./api_calls/bbb_config.md)
+
+- [Contributing]()
+  - [How to Contribute](./contributing/contributing.md)
+  - [Style Guide](./contributing/style_guide.md)
+  - [Running Tests](./contributing/testing.md)
+  - [Documentation](./contributing/documentation.md)
+
+- [Other]()
+  - [Full Usage Sample](./other/full_usage_sample.md)
+  - [FAQ](./other/faq.md)
+  - [External Links](./other/external_links.md)

docs/src/api_calls/bbb_config.md

@@ -0,0 +1,6 @@
+{{#include ../header.md}}
+
+# Server Configuration
+> [!WARNING]  
+> The content of this section is outdated and is currently under review!
+> Please feel invited to contribute!

docs/src/api_calls/hooks.md

@@ -0,0 +1,6 @@
+{{#include ../header.md}}
+
+# Hooks
+> [!WARNING]  
+> The content of this section is outdated and is currently under review!
+> Please feel invited to contribute!