docs

docs/SETUP.md

@@ -41,44 +41,7 @@ volumes:
   notebook_data:
 ```
 
-or with the environment variables:
-
-```yaml
-version: '3'
-
-services:
-  surrealdb:
-    image: surrealdb/surrealdb:v2
-    ports:
-      - "8000:8000"
-    volumes:
-      - surreal_data:/mydata
-    command: start --log trace --user root --pass root rocksdb:/mydata/mydatabase.db
-    pull_policy: always
-    user: root
-
-  open_notebook:
-    image: lfnovo/open_notebook:latest
-    ports:
-      - "8080:8502"
-    environment:
-        - OPENAI_API_KEY=API_KEY
-        - SURREAL_ADDRESSsurrealdb
-        - SURREAL_PORT=8000
-        - SURREAL_USER=root
-        - SURREAL_PASS=root
-        - SURREAL_NAMESPACE=open_notebook
-        - SURREAL_DATABASE=staging
-    depends_on:
-      - surrealdb
-    pull_policy: always
-    volumes:
-      - notebook_data:/app/data
-
-volumes:
-  surreal_data:
-  notebook_data:
-```
+Take a look at the [Open Notebook Boilerplate](https://github.com/lfnovo/open-notebook-boilerplate) repo with a sample of how to set it up for maximum feature usability. 
 
 ### 📦 Installing from Source
 

docs/TRANSFORMATIONS.md

@@ -24,6 +24,8 @@ For example, you could start by summarizing a text, then use that summary to gen
 
 ### Setting Up Transformations
 
+Take a look at the [Open Notebook Boilerplate](https://github.com/lfnovo/open-notebook-boilerplate) repo with a sample of how to set it up for maximum feature usability. 
+
 To set up your own Transformations, you'll define them in the `transformations.yaml` file. Below is an example setup:
 
 ```yaml
@@ -32,34 +34,37 @@ source_insights:
     insight_type: "Content Summary"
     description: "Summarize the content"
     patterns:
-      - patterns/makeitdense
-      - patterns/summarize
+      - patterns/default/makeitdense
+      - patterns/default/summarize
   - name: "Key Insights"
     insight_type: "Key Insights"
     description: "Extracts a list of the Key Insights of the content"
     patterns:
-      - patterns/keyinsights
+      - patterns/default/keyinsights
   - name: "Make it Dense"
     insight_type: "Dense Representation"
     description: "Create a dense representation of the content"
     patterns:
-      - patterns/makeitdense
+      - patterns/default/makeitdense
   - name: "Analyze Paper"
     insight_type: "Paper Analysis"
     description: "Analyze the paper and provide a quick summary"
     patterns:
-      - patterns/analyze_paper
+      - patterns/default/analyze_paper
   - name: "Reflection"
     insight_type: "Reflection Questions"
     description: "Generates a list of insightful questions to provoke reflection"
     patterns:
-      - patterns/reflection_questions
+      - patterns/default/reflection_questions
 ```
 
-Once you've defined your transformation, make sure to add the corresponding prompts to the `prompts/patterns` folder. Here's an example of a transformation prompt:
+You can mount this file to the docker image to replace its default value. 
+
+
+Once you've defined your transformation, make sure to add the corresponding prompts to the `prompts/patterns/user` folder. Here's an example of a transformation prompt:
 
 ```jinja
-{% include 'patterns/common_text.jinja' %}
+{% include 'patterns/user/common_text.jinja' %}
 
 # IDENTITY and PURPOSE
 
@@ -95,7 +100,6 @@ You extract deep, thought-provoking, and meaningful reflections from text conten
 - Any item that doesn't follow the `patterns/` format will be interpreted as a command (refer to `command.jinja` for clarity).
 
 
-
 ### Call for Contributions
 
 Have an idea for an amazing Transformation? We'd love to see your creativity! Please submit a pull request with your favorite transformations to help expand our library. Whether it's summarization, content analysis, or something entirely unique, your contributions will help us all get more out of our research!Leveraging Transformations in Open Notebook