docs: write contribute page

Author: LeadcodeDev

.DS_Store

@@ -1,25 +1,27 @@
 
 export default new Map([
+["src/content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/cli.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcli.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/commands.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcommands.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/container.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcontainer.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/components.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcomponents.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/environment-variables.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fenvironment-variables.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/global-states.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fglobal-states.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/hmr.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fhmr.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/interactive-components.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Finteractive-components.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fevent.mdx&astroContentModuleFlag=true")],
+["src/content/docs/api/placeholders.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fplaceholders.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/guide/deployment.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fdeployment.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/guide/commands.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fcommands.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/guide/environment-variables.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fenvironment-variables.mdx&astroContentModuleFlag=true")],
-["src/content/docs/guide/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fevent.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/guide/installation.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Finstallation.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/cli.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcli.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/components.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcomponents.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/container.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcontainer.mdx&astroContentModuleFlag=true")],
+["src/content/docs/guide/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fevent.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/guide/structure.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fstructure.mdx&astroContentModuleFlag=true")],
-["src/content/blog/welcome.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fblog%2Fwelcome.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/commands.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fcommands.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/global-states.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fglobal-states.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/hmr.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fhmr.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/environment-variables.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fenvironment-variables.mdx&astroContentModuleFlag=true")],
-["src/content/docs/concepts/data-caching.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fdata-caching.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/concepts/datastore.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fdatastore.mdx&astroContentModuleFlag=true")],
+["src/content/docs/concepts/data-caching.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fdata-caching.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/concepts/immutability.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fconcepts%2Fimmutability.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/event.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fevent.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/placeholders.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fplaceholders.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/interactive-components.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Finteractive-components.mdx&astroContentModuleFlag=true")],
 ["src/content/docs/examples/ping-pong.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fexamples%2Fping-pong.mdx&astroContentModuleFlag=true")],
-["src/content/docs/api/providers.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fproviders.mdx&astroContentModuleFlag=true")]]);
+["src/content/docs/api/providers.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fapi%2Fproviders.mdx&astroContentModuleFlag=true")],
+["src/content/docs/guide/deployment copy.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fdeployment+copy.mdx&astroContentModuleFlag=true")],
+["src/content/docs/guide/contribute.mdx", () => import("astro:content-layer-deferred-module?astro%3Acontent-layer-deferred-module=&fileName=src%2Fcontent%2Fdocs%2Fguide%2Fcontribute.mdx&astroContentModuleFlag=true")]]);
 

.astro/content-modules.mjs

@@ -1,5 +1,5 @@
 {
 	"_variables": {
-		"lastUpdateCheck": 1753976649467
+		"lastUpdateCheck": 1760137384856
 	}
 }

.astro/data-store.json

@@ -11,8 +11,8 @@ order: 11
 Within the Mineral ecosystem, HMR (Hot Module Reloading) is a feature that automatically reloads your business code
 without having to restart your project or recreate a connection to Discord's Websocket API.
 
-> [!warning]
-> This feature is experimental and may not work as expected.
+> [!important]
+> The integration of HMR uses an agnostic package named [`hmr`](https://pub.dev/packages/hmr).
 
 ---
 
@@ -22,8 +22,7 @@ This feature is particularly useful when you are developing your application and
 
 It is important to note that the HMR only reloads the contents of your root project's (based on the following glob pattern `**.dart`) without any external dependencies.
 
-> [!important]
-> The integration of HMR has been moved to a dedicated, agnostic package [`hmr`](https://pub.dev/packages/hmr).
+---
 
 ## How it works
 

.astro/settings.json

@@ -3,8 +3,9 @@ title: Commands
 description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 permalink: commands
 icon: lucide:square-slash
-order: 5
+order: 6
 ---
+
 # Commands
 
 Slash commands were implemented with the aim of replacing messages considered as commands with a start-of-line
@@ -31,6 +32,7 @@ syntax errors.
 From the `Client`, we can chain commands listeners using the following pattern :
 
 :::code-group labels=[main.dart]
+
 ```dart
 Future<void> main(_, port) async {
   final client = ClientBuilder()
@@ -47,22 +49,24 @@ Future<void> main(_, port) async {
   await client.init();
 }
 ```
+
 :::
 
 ---
 
 ## Object-oriented approach
 
-For benchmarking purposes, we recommend using the `functional` approach, but when developing applications requiring 
+For benchmarking purposes, we recommend using the `functional` approach, but when developing applications requiring
 more than 2 events or commands, we recommend using the object-oriented approach.
 
 :::code-group labels=[command.dart, main.dart]
+
 ```dart
 final class MyCommand implements CommandDeclaration {
   void handle(CommandContext ctx) {
     print('Hello, world!');
   }
-  
+
   @override
   CommandDeclarationBuilder build() {
     return CommandDeclarationBuilder()
@@ -72,6 +76,7 @@ final class MyCommand implements CommandDeclaration {
   }
 }
 ```
+
 ```dart
 Future<void> main(_, port) async {
   final client = ClientBuilder()
@@ -83,4 +88,5 @@ Future<void> main(_, port) async {
   await client.init();
 }
 ```
-:::
+
+:::

src/content/docs/api/hmr.mdx

@@ -0,0 +1,152 @@
+---
+title: Contribute
+description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+permalink: contribute
+icon: lucide:sparkles
+order: 1
+---
+
+# Contribute
+
+Contributions are the basis of any open-source project. They enable the project to evolve, fix bugs, add features and much more.
+We're delighted that you want to contribute to our project !
+
+> [!important]
+> Your help is invaluable in improving and growing this project.
+
+---
+
+## How to contribute
+
+Contributions can take several forms. Here are a few examples:
+
+- Improving the documentation with your feedback and experiments
+- Report and/or fixing bugs in [issues](https://github.com/mineral-dart/core/issues)
+- Adding missing functionalities through forks and pull requests
+- Suggest improvements to the user experience
+- Help the community by answering questions from other users
+
+---
+
+## Improving the documentation
+
+The documentation is the first point of contact for users. It must be clear, concise and easy to understand.
+
+This aspect of the project is crucial to its adoption and use by the community, but it takes up an infinite amount of
+time to write, to the detriment of the actual development of new features.
+
+---
+
+### API documentation
+
+The API documentation is generated using the `dartdoc` tool. It is automatically generated and updated with each new
+release.
+
+Each method must be documented, as well as each parameter, return type and exception.
+It's this aspect in particular that consumes an infinite amount of our time.
+
+Si vous souhaitez-nus aider à améliorer la documentation, vous pouvez suivre les étapes suivantes :
+
+1. Fork the project
+2. Make your `dartdoc` comments
+3. Push your changes and create a pull request
+
+You can also use the following template to document the methods :
+
+````dart
+/// Title of the method
+///
+/// Description of the method
+///
+/// Example :
+/// ```dart
+/// // Code example
+/// ```
+///
+void fn() {}
+````
+
+### Website documentation
+
+The framework documentation is the second most important part of the documentation.
+understand how to use the framework.
+
+Unlike API documentation, here we'll explain the concepts, functionalities and best practices, while providing
+theoretical and concrete examples to help users understand how the framework works while providing theoretical and
+practical examples to help users understand how the framework works.
+
+If you wish to clarify certain points, add examples or even correct errors, you can follow the steps below:
+
+1. Fork the [repository](https://github.com/mineral-dart/website)
+2. Make your changes
+3. Push your changes and create a pull request
+4. Wait for the review
+5. Once the review is complete, your changes will be merged
+
+### Reporting bugs
+
+Bugs are a common occurrence in software development. They can be caused by a variety of factors, such as incorrect
+implementation, incorrect use of the framework, or even a lack of understanding of the framework.
+
+The more information you provide, the easier it will be for us to reproduce the bug and correct it, so we recommend that
+you provide the following information.
+
+- Give context (show `pubspec.yaml`)
+- Description of the bug (copy/paste the error message)
+- Steps to reproduce the bug
+- Expected behavior
+- Actual behavior
+- Screenshots or code snippets (optional)
+
+If you encounter a bug, you can report it by following these steps:
+
+1. Go to the [issues](https://github.com/mineral-dart/core/issues/new)
+2. Fill in the form with the necessary information
+3. Click on the "Submit new issue" button
+4. Wait for the review by the core team
+
+### Adding missing features
+
+The framework is constantly evolving. New features are added regularly to improve the user experience and make the
+framework more complete.
+
+> [!note]
+> You can find the roadmap [here](https://github.com/orgs/mineral-dart/projects/5/views/2).
+
+#### Installation
+
+When we develop the core functionalities, it is preferable to create a blank application simulating a real application
+with the `core` package at the same folder level.
+
+We therefore consider the following structure :
+
+```
+├── root
+│  └── bot
+│  └── core
+│  │
+│  └── other packages
+```
+
+In your bot application `pubspec.yaml` file, add the following dependency.
+
+> [!note]
+> In accordance with the [documentation](https://dart.dev/tools/pub/dependencies), using a `path` allows you to develop functionality locally.
+
+:::code-group labels=[pubspec.yaml, bash]
+
+```yaml
+dependencies:
+  mineral:
+    path: ../core
+
+  # Optional
+  mineral_cache:
+    path: ../cache
+```
+
+```bash
+dart pub get
+```
+
+:::

src/content/docs/guide/commands.mdx

@@ -3,8 +3,9 @@ title: Environment variables
 description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 permalink: environment-variables
 icon: lucide:key-round
-order: 3
+order: 4
 ---
+
 # Environment variables
 
 Environment variables serve the purpose of storing secrets like the database password, the app secret, or an API key outside of your application codebase.
@@ -19,6 +20,7 @@ In addition, environment variables can be used to obtain different configuration
 We're providing an `Environment` class to access the various environment variables in your application.
 
 :::code-group labels=[.env, schema.dart]
+
 ```dotenv
 DART_ENV=development
 TOKEN=your_token
@@ -27,6 +29,7 @@ DISCORD_WS_VERSION=10
 INTENT=3276799
 LOG_LEVEL=TRACE
 ```
+
 ```dart
 final class AppEnv implements DefineEnvironment {
   static final String dartEnv = 'DART_ENV';
@@ -57,4 +60,5 @@ enum DartEnv implements Enumerable<String> {
   const DartEnv(this.value);
 }
 ```
-:::
+
+:::

src/content/docs/guide/contribute.mdx

@@ -3,8 +3,9 @@ title: Events
 description: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 permalink: events
 icon: lucide:bell
-order: 4
+order: 5
 ---
+
 # Events
 
 The Discord API uses a real-time event system transmitted via a WebSocket connection to allow client applications to receive instant updates from the server.
@@ -31,9 +32,11 @@ Let's take a simple example of a bot that listens to the `MessageCreate` event a
 From the `Client`, we can chain event listeners using the following pattern :
 
 :::code-group labels=[boilerplate, main.dart]
+
 ```dart
 client.events.<context>.<event>(<listener>)
 ```
+
 ```dart
 Future<void> main(_, port) async {
   final client = ClientBuilder()
@@ -47,16 +50,18 @@ Future<void> main(_, port) async {
   await client.init();
 }
 ```
+
 :::
 
 ---
 
 ## Object-oriented approach
 
-For benchmarking purposes, we recommend using the `functional` approach, but when developing applications requiring 
+For benchmarking purposes, we recommend using the `functional` approach, but when developing applications requiring
 more than 2 events or commands, we recommend using the object-oriented approach.
 
 :::code-group labels=[boilerplate, message_create.dart, main.dart]
+
 ```dart
 final class <ClassName> extends <Event> {
   @override
@@ -65,6 +70,7 @@ final class <ClassName> extends <Event> {
   }
 }
 ```
+
 ```dart
 final class MessageCreate extends MessageCreateEvent {
   @override
@@ -73,6 +79,7 @@ final class MessageCreate extends MessageCreateEvent {
   }
 }
 ```
+
 ```dart
 Future<void> main(_, port) async {
   final client = ClientBuilder()
@@ -84,4 +91,5 @@ Future<void> main(_, port) async {
   await client.init();
 }
 ```
-:::
+
+:::