Update documentation to enhance clarity and structure, including examples and useful links

Author: grongierisc

docs/example.md

@@ -1,10 +1,10 @@
 # Example
 
-Add an example of a business operation and messages in Python.
+This document provides an example of a business operation and messages in Python, along with instructions on how to register a component.
 
 ## Business Operation
 
-Here is an example of a business operation in Python:
+Below is an example of a business operation in Python:
 
 ```python
 from iop import BusinessOperation, Message
@@ -14,18 +14,18 @@ class MyBusinessOperation(BusinessOperation):
 
     def on_init(self):
         # This method is called when the component is becoming active in the production
-        self.log_info("[Python] ...MyBusinessOperation:on_init() is called")
+        self.log_info("[Python] MyBusinessOperation:on_init() is called")
         return
 
     def on_teardown(self):
         # This method is called when the component is becoming inactive in the production
-        self.log_info("[Python] ...MyBusinessOperation:on_teardown() is called")
+        self.log_info("[Python] MyBusinessOperation:on_teardown() is called")
         return
 
     def on_message(self, message_input: 'MyRequest'):
         # Called from service/process/operation, message is of type MyRequest with property request_string
-        self.log_info("[Python] ...MyBusinessOperation:on_message() is called with message:" + message_input.request_string)
-        response = MyResponse("...MyBusinessOperation:on_message() echos")
+        self.log_info("[Python] MyBusinessOperation:on_message() is called with message: " + message_input.request_string)
+        response = MyResponse("MyBusinessOperation:on_message() echos")
         return response
 
 @dataclass
@@ -37,13 +37,17 @@ class MyResponse(Message):
     my_string: str = None
 ```
 
-## Register a Component
+### Explanation
+
+- **on_init**: This method is called when the component becomes active in the production.
+- **on_teardown**: This method is called when the component becomes inactive in the production.
+- **on_message**: This method is called from service/process/operation, and it processes the incoming message of type `MyRequest`.
 
-To register a component, you need to create a setting.py file in the root of your project.
+## Register a Component
 
-This file will be used to register your classes and productions.
+To register a component, create a `setting.py` file in the root of your project. This file will be used to register your classes and productions.
 
-Example of setting.py:
+### Example of `setting.py`
 
 ```python
 import bo
@@ -53,8 +57,10 @@ CLASSES = {
 }
 ```
 
-Then you can use the iop command line to register your component:
+### Registering the Component
+
+Use the `iop` command line to register your component:
 
 ```bash
 iop --migrate /path/to/your/project/setting.py
-```
+```

docs/getting-started/installation.md

@@ -8,8 +8,7 @@ Before you begin, ensure you have the following installed:
 
 - Python 3.6 or higher
 - IRIS 2021.1 or higher
-- Embedded Python configured in IRIS
-  - [Configuring Embedded Python](TODO: Add link to the guide)
+- [Configuring Embedded Python](TODO: Add link to the guide)
 
 ## With PyPi
 

docs/index.md

@@ -1,9 +1,35 @@
-IoP (Interoperability On Python)
+# IoP (Interoperability On Python)
 
 [![PyPI - Status](https://img.shields.io/pypi/status/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
 [![PyPI](https://img.shields.io/pypi/v/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
 [![PyPI - License](https://img.shields.io/pypi/l/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
 ![GitHub last commit](https://img.shields.io/github/last-commit/grongierisc/interoperability-embedded-python)
 
-This proof of concept aims to show how the **iris interoperability framework** can be use with **embedded python**.
+Welcome to the **Interoperability On Python (IoP)** proof of concept! This project demonstrates how the **IRIS Interoperability Framework** can be utilized with a **Python-first approach**.
+
+## Example
+
+Here's a simple example of how a Business Operation can be implemented in Python:
+
+```python
+from iop import BusinessOperation
+
+class MyBo(BusinessOperation):
+    def on_message(self, request):
+        self.log_info("Hello World")
+```
+
+## Installation
+
+To start using this proof of concept, install it using pip:
+
+```bash
+pip install iris-pex-embedded-python
+```
+
+## Getting Started
+
+If you're new to this proof of concept, begin by reading the [installation guide](getting-started/installation.md). Then, follow the [first steps](getting-started/first-steps.md) to create your first Business Operation.
+
+Happy coding!

docs/useful-links.md

@@ -0,0 +1,35 @@
+## Useful Links
+
+Explore the following resources to learn more about the project and see it in action:
+
+### Training
+- [Training Repository](https://github.com/grongierisc/formation-template-python)  
+  A repository to learn how to use the project.
+
+### Templates
+- [Project Template](https://github.com/grongierisc/iris-python-interoperability-template)  
+  A template to start a new project.
+
+### Project Links
+- [PyPI](https://pypi.org/project/iris-pex-embedded-python/)  
+  The project on PyPI.
+- [GitHub](https://github.com/grongierisc/iris-python-interoperability-template)  
+  The project on GitHub.
+
+### Demos
+- [Flask Demo](https://github.com/grongierisc/iris-flask-template)  
+  Demonstrates how to use the project with Flask.
+- [FastAPI Demo](https://github.com/grongierisc/iris-fastapi-template)  
+  Demonstrates how to use the project with FastAPI.
+- [Django Demo](https://github.com/grongierisc/iris-django-template)  
+  Demonstrates how to use the project with Django.
+- [Kafka Demo](https://github.com/grongierisc/iris-kafka-python)  
+  Example of using the project with Kafka.
+- [RAG Demo](https://github.com/grongierisc/iris-rag-demo)  
+  Example of using the project with RAG.
+- [IRIS Chemical](https://github.com/grongierisc/iris-chemicals-properties)  
+  Example of extracting chemical properties.
+- [Rest to DICOM](https://github.com/grongierisc/RestToDicom)  
+  Example of using the project with RestToDicom.
+- [OCR](https://github.com/grongierisc/iris-pero-ocr)  
+  Example of using the project with an OCR engine.

mkdocs.yml

@@ -8,7 +8,10 @@ nav:
   - Getting Started:
     - Installation: getting-started/installation.md
     - First Steps: getting-started/first-steps.md
-  - Example: example.md
-  - Command Line: command-line.md
+  - Reference:
+    - Example: example.md
+    - Useful Links: useful-links.md
+  - API documentation:
+    - Command Line Interface: command-line.md
 
 theme: readthedocs