Plugin C/C++: Extend documentation

* Provide separated instructions for templates
* Separated README file for each template
* Extend documentation in source code

Author: AmmarAbouZor

plugins/templates/c-cpp/README.md

@@ -2,3 +2,27 @@
 
 This directory contains ready-to-use templates for Chipmunk plugins written in C/C++. 
 Plugin developers can simply copy a template directory to quickly start a new plugin project.
+
+## Step-by-Step Guide
+
+1. **Prerequisites**: Ensure all necessary tools, SDKs, and Chipmunk WIT files are available locally. Refer to the [C/C++ Plugins Development Guide](https://esrlabs.github.io/chipmunk/plugins/development-guide/) for detailed setup instructions.
+
+2. **Configuration**: Provide required paths either directly within the `Makefile` or by passing them as arguments to the `make` CLI command.
+
+3. **Compilation**: Run `make all {arguments}` to compile the template plugins. This command performs the following actions:
+  * Generates bindings from Chipmunk WIT files.
+  * Downloads the latest `wasi reactor` if its path is not specified.
+  * Generates the plugin WASM component file in the `dist` directory. For parser templates, the file will be named `my_parser.wasm`.
+
+4. **Plugin Integration**: To integrate the compiled plugin into Chipmunk:
+  1.  Create a directory for your plugin within the Chipmunk plugins directory. For parser plugins, this path is `~/.chipmunk/plugins/parsers`. The directory name for this template example would be `my_parser`.
+  2.  Copy the compiled plugin WASM component file into the newly created directory.
+  3.  For more detailed integration steps, refer to the [Plugins Integration Documentation](https://esrlabs.github.io/chipmunk/plugins/development-guide/#building-and-integrating-plugins).
+
+5. **Using Plugins in Chipmunk**:
+  1.  Navigate to the **Plugins Manager** in the Chipmunk UI to verify that your plugin is integrated and validated successfully.
+  2.  Start a session, for example, a CLI command session from *Terminal/Execute Command*.
+  3.  Select your plugin from the dropdown menu. For the parser template, it will be named `my_parser`.
+  4.  The configuration schemas defined by the plugin will be displayed on the UI, allowing you to provide necessary inputs.
+  5.  Start the session to view the parsed messages. If Chipmunk is running in a terminal, you can also check logs printed to standard output.
+  6.  For additional details and demonstrations, refer to the [Plugins Integrations in Chipmunk UI](https://esrlabs.github.io/chipmunk/plugins/integration-ui/).

plugins/templates/c-cpp/parser_c/Makefile

@@ -36,7 +36,7 @@ WIT_BINDGEN_ALL_GENERATED = $(WIT_BINDGEN_GENERATED_C_SRC) $(WIT_BINDGEN_GENERAT
 
 # Name of the intermediate WASM binary module.
 CORE_WASM_MODULE = $(BUILD_DIR)/plugin_intermediate_module.wasm
-# Name of plugin final WASM component file.
+# Name of plugin final WASM component file. This must match the name of the plugin itself.
 FINAL_WASM_COMPONENT := $(DIST_DIR)/my_parser.wasm
 
 # Use clang and sysroots from WASI SDK

plugins/templates/c-cpp/parser_c/README.md

@@ -0,0 +1,5 @@
+# C Parser Plugin Template
+
+This is a starter template for developing parser plugins in C. Copy this template to quickly begin a new plugin project.
+
+For detailed instructions, please refer to the [Step-by-Step Guide](../README.md).

plugins/templates/c-cpp/parser_c/src/my_parser.c

@@ -30,12 +30,17 @@ void exports_chipmunk_parser_parser_get_version(
   ret->patch = 0;
 }
 
-/// Provides the schemas for the configurations required by the plugin, which
-/// will be specified by the users.
+/// Provides the schemas for the configurations required by the plugin.
 ///
-/// These schemas define the expected structure, types, and constraints
-/// for plugin-specific configurations. The values of these configurations
-/// will be passed to the initializing method of the parser.
+/// These schemas define the expected structure, types, and constraints for
+/// plugin-specific configurations that users will specify. Chipmunk uses these
+/// schemas to render UI controls, which are presented to users before starting
+/// a session, allowing them to provide values for these configurations.
+///
+/// The values collected from these configurations are then passed to the
+/// parser's initialization method. Developers should refer to the WIT files
+/// and the generated bindgen for a complete list of available configuration
+/// schemas.
 void exports_chipmunk_parser_parser_get_config_schemas(
     exports_chipmunk_parser_parser_list_config_schema_item_t *ret) {
   ret->ptr = (exports_chipmunk_parser_parser_config_schema_item_t *)calloc(
@@ -107,8 +112,13 @@ void exports_chipmunk_parser_parser_get_render_options(
 #endif
 }
 
-/// Initialize the parser with the given configurations
-/// This function will be called upon starting a parsing session.
+/// Initializes the parser with the provided configurations.
+///
+/// This function is called when a parsing session starts. It receives the
+/// general parser configurations applicable to all parsing plugins, along
+/// with specific configuration values defined by the
+/// `exports_chipmunk_parser_parser_get_config_schemas()` function for this
+/// plugin.
 bool exports_chipmunk_parser_parser_init(
     exports_chipmunk_parser_parser_parser_config_t *general_configs,
     exports_chipmunk_parser_parser_list_config_item_t *plugin_configs,

plugins/templates/c-cpp/parser_cpp/Makefile

@@ -39,7 +39,7 @@ WIT_BINDGEN_COMPILED_C_SRC := $(BUILD_DIR)/parse.o
 
 # Name of the intermediate WASM binary module.
 CORE_WASM_MODULE = $(BUILD_DIR)/plugin_intermediate_module.wasm
-# Name of plugin final WASM component file.
+# Name of plugin final WASM component file. This must match the name of the plugin itself.
 FINAL_WASM_COMPONENT := $(DIST_DIR)/my_parser.wasm
 
 # Use clang and sysroots from WASI SDK

plugins/templates/c-cpp/parser_cpp/README.md

@@ -0,0 +1,5 @@
+# C++ Parser Plugin Template
+
+This is a starter template for developing parser plugins in C++. Copy this template to quickly begin a new plugin project.
+
+For detailed instructions, please refer to the [Step-by-Step Guide](../README.md).

plugins/templates/c-cpp/parser_cpp/src/my_parser.cpp

@@ -29,12 +29,17 @@ void exports_chipmunk_parser_parser_get_version(
   ret->patch = 0;
 }
 
-/// Provides the schemas for the configurations required by the plugin, which
-/// will be specified by the users.
+/// Provides the schemas for the configurations required by the plugin.
 ///
-/// These schemas define the expected structure, types, and constraints
-/// for plugin-specific configurations. The values of these configurations
-/// will be passed to the initializing method of the parser.
+/// These schemas define the expected structure, types, and constraints for
+/// plugin-specific configurations that users will specify. Chipmunk uses these
+/// schemas to render UI controls, which are presented to users before starting
+/// a session, allowing them to provide values for these configurations.
+///
+/// The values collected from these configurations are then passed to the
+/// parser's initialization method. Developers should refer to the WIT files
+/// and the generated bindgen for a complete list of available configuration
+/// schemas.
 void exports_chipmunk_parser_parser_get_config_schemas(
     exports_chipmunk_parser_parser_list_config_schema_item_t *ret) {
   ret->ptr = new exports_chipmunk_parser_parser_config_schema_item_t[3];
@@ -103,8 +108,13 @@ void exports_chipmunk_parser_parser_get_render_options(
 #endif
 }
 
-/// Initialize the parser with the given configurations
-/// This function will be called upon starting a parsing session.
+/// Initializes the parser with the provided configurations.
+///
+/// This function is called when a parsing session starts. It receives the
+/// general parser configurations applicable to all parsing plugins, along
+/// with specific configuration values defined by the
+/// `exports_chipmunk_parser_parser_get_config_schemas()` function for this
+/// plugin.
 bool exports_chipmunk_parser_parser_init(
     exports_chipmunk_parser_parser_parser_config_t *general_configs,
     exports_chipmunk_parser_parser_list_config_item_t *plugin_configs,