updates docs

Author: neagualexa

README.md

@@ -1,6 +1,6 @@
-# Lambda Feedback Chat Function Boilerplate
+# Informational Chatbot
 
-This repository contains the code needed to develop a modular chatbot to be used on Lambda-Feedback platform [written in Python].
+This repository contains the code of a modular chatbot to be used on Lambda-Feedback platform [written in Python].
 
 ## Quickstart
 

docs/dev.md

@@ -1,14 +1,40 @@
-# YourFunctionName
-*Brief description of what this chat function does, from the developer perspective*
+# informationalChatFunction
+This chatbot aims to complete all the relevant tasks the student requests based on the current Question they are working on. The Chatbot is aware of the Question details, answer, worked solution and guidance from the lecturer.
+
+Some technical details:
+<pre style="white-space: pre-wrap;">
+<code>LLM model: Gemini-2.0-flash (Google)
+response time (on average): 10 seconds
+
+Helping approach: encourages self-discovery of the answer, but will reveal the solution if requested
+</code>
+</pre>
 
 ## Inputs
-*Specific input parameters which can be supplied when the calling this chat function.*
+Body:
+```JSON
+{
+    "message":"hi",
+    "params":{
+        "conversation_id":"12345Test",
+        "conversation_history":[{"type":"user","content":"hi"}],
+        "include_test_data": true,
+    }
+}
+```
 
 ## Outputs
-*Output schema/values for this function*
-
-## Examples
-*List of example inputs and outputs for this function, each under a different sub-heading*
+```JSON
+{
+    "chatbotResponse":"hi back",
+    "metadata": {
+        "summary": "",
+        "conversational_style": "",
+        "conversation_history": [],
+    },
+    "processing_time": 0
+}
+```
 
 ## Testing the Chat Function
 

docs/user.md

@@ -1,3 +1,12 @@
-# YourChatFunctionName
+# Informational Chatbot
 
-Teacher- & Student-facing documentation for this function.
+This chatbot aims to complete all the relevant tasks the student requests based on the current Question they are working on. The Chatbot is aware of the Question details, answer, worked solution and guidance from the lecturer.
+
+Some technical details:
+<pre style="white-space: pre-wrap;">
+<code>LLM model: Gemini-2.0-flash (Google)
+response time (on average): 10 seconds
+
+Helping approach: encourages self-discovery of the answer, but will reveal the solution if requested
+</code>
+</pre>