Fix typos in docs

README.md

@@ -6,6 +6,8 @@ Functions are deeply integrated in the CIM Database Cloud Webhooks technology. T
 
 **Documentation:** https://cslab.github.io/functions-sdk-python/
 
+**Source code:** https://github.com/cslab/functions-sdk-python
+
 ## Requirements
 
 Python 3.10+

docs/getting_started.md

@@ -12,7 +12,7 @@ pip install contactsoftware-functions
 A minimal Function implementation consists of three files:
 
 - `environment.yaml` describes the environment and the Functions contained in it
-- `requirements.txt` contains the dependencies of you Functions (usually only contactsoftware-functions)
+- `requirements.txt` contains the dependencies of your Functions (usually only contactsoftware-functions)
 - `mymodule.py` a Python file containing the code of your Functions (feel free to pick a different name)
 
 Here is the complete structure:
@@ -37,7 +37,7 @@ def send_doc_to_erp(metadata: MetaData, event: DocumentReleaseEvent, service: Se
 ```
 
 While you don't have to use type annotations, it is highly recommended because it enables autocomplete in your IDE and helps you spot mistakes faster.
-For our example we only need the DocumentReleaseEvent. It contains a list of documents that were released. Typically this will only be a single document, however it is best practices to iterate over all of the documents.
+For our example we only need the [DocumentReleaseEvent](reference/events.md/#documentreleaseevent). It contains a list of documents that were released. Typically this will only be a single document, however it is best practices to iterate over all of the documents.
 
 ``` python title="mymodule.py"
 import requests
@@ -61,6 +61,9 @@ def send_doc_to_erp(metadata: MetaData, event: DocumentReleaseEvent, service: Se
 
 ```
 
+Here we send a payload, containing a few attributes from the released document, to [example.com](https://example.com). This is just for illustration purposes!
+Please refer to the documentation of your ERP system on how the request needs to be formatted and which endpoint and credentials to use.
+
 ### Register the Function
 
 The Function needs to be registered in the `environment.yaml`:
@@ -113,6 +116,6 @@ Upload code into new environment:
 cfc env deploy myenv
 ```
 
-### Test the function
-To test your function you need to connect the Function to an event in your CIM Database Cloud instance.
+### Test the Function
+To test your Function you need to connect the Function to an event in your CIM Database Cloud instance.
 Please refer to the Webhooks CIM Database Cloud documentation on how to do that.

docs/reference/runtime.md

@@ -1,5 +1,5 @@
 This section is aimed at developers that want to build their own Functions-SDK.
-If are building Functions with **csfunctions** you can skip this part.
+If you are building Functions with **csfunctions** you can skip this part.
 
 ## Architecture
 Function environment are docker containers that run in AWS-lambda. The Python runtime utilizes awslambdaric to handle the requests. The Python runtime is part of the CIM Database Cloud Functions infrastructure and currently cannot be customized.
@@ -38,4 +38,4 @@ The return value of the execute method is the json encoded response payload.
 
 ## Payloads
 
-The Request and response payloads are described in the CIM Database Cloud documentation. The functions-sdk-python GitHub repository also contains the complete JSON-schema files.
+The Request and response payloads are described in the CIM Database Cloud documentation. The [functions-sdk-python](https://github.com/cslab/functions-sdk-python) GitHub repository also contains the complete [JSON-schema files](https://github.com/cslab/functions-sdk-python/tree/main/json_schemas).

pyproject.toml

@@ -9,6 +9,8 @@ authors = [
     "Jens Kürten <[email protected]>"
 ]
 description = "Library for creating Functions for CIM Database Cloud."
+repository = "https://github.com/cslab/functions-sdk-python"
+documentation = "https://cslab.github.io/functions-sdk-python/"
 
 packages = [
     { include = "csfunctions"}