Introduce documentation in docs-folder

README.md

@@ -23,11 +23,29 @@ The official **BigBlueButton PHP API Client** provides a developer-friendly wrap
 the **BigBlueButton** API. Built for **PHP 8.2+**, this library simplifies integration and management of
 BigBlueButton servers in your PHP applications.
 
----
+## Installation and Usage
+
+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.
 
 ## 📦 Installation & Usage
 
-You can find the full documentation, including sample usage and installation instructions, in our [Wiki].
+
+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
+
+Make sure the code style configuration is applied by running PHPCS-Fixer.
 
 ```bash
 composer require bigbluebutton/bigbluebutton-api-php
@@ -64,18 +82,21 @@ composer code-check
 ./vendor/bin/phpstan analyse
 ```
 
-### 3. Running Tests
+# using an alias
+$ composer code-test
 
-```bash
-composer code-test
-# Or
-./vendor/bin/phpunit
+# or the same w/o alias
+$ ./vendor/bin/phpunit
 ```
 
 To run a specific test:
 
 ```bash
-composer code-test -- --filter BigBlueButtonTest::testApiVersion
+# using an alias
+$ composer code-test -- --filter BigBlueButtonTest::testApiVersion
+
+# or the same w/o alias
+$ ./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion
 ```
 
 To skip code coverage:

docs/.gitignore

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

docs/book.toml

@@ -0,0 +1,37 @@
+[book]
+title = "BigBlueButton PHP API Library - Documentation"
+description = "BigBlueButton PHP API Library - Documentation"
+authors = ["Ghazi Triki", "Tim Korn"]
+language = "en"
+src = "src"
+
+[build]
+create-missing = false   # whether or not to create missing pages
+
+# Activate extensions (preprocessors)
+[preprocessor.index]
+
+[output.html]
+default-theme = "light"
+preferred-dark-theme = "navy"
+additional-css = ["theme/css/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!