Update prompts authored by Ramicés dos Santos Silva's avatar Ramicés dos Santos Silva
...@@ -16,23 +16,11 @@ ...@@ -16,23 +16,11 @@
## Overview documentation ## Overview documentation
### For System introduction overview ### For System introduction overview
`
Give a brief high level system overview and its purpose using the provided context for this program, keep it detailed, concise and confident. `Give a brief high level system overview and its purpose using the provided context for this program, keep it detailed, concise and confident.`
### For High Level Doc creation ### For High Level Doc creation
Based on the provided code module, generate a comprehensive analysis as follows:
- **Module Name**: Identify the module with fullpath for module file.
- **Primary Objectives**: Define its purpose.
- **Critical Functions**: List main methods/functions and their roles.
- **Key Variables**: Point out essential variables.
- **Interdependencies**: Note interactions with other system components.
- **Core vs. Auxiliary Operations**: Differentiate main operations from auxiliary ones.
- **Operational Sequence**: Describe any distinct flow.
- **Usage**: Discuss how it is used.
- **Assumptions**: List any assumptions made.
`
### For Mermaid Diagram creation ### For Mermaid Diagram creation
Create a basic level-1 Data Flow Diagram (DFD) in Mermaid js syntax. Do not include parameters in function calls. Create a basic level-1 Data Flow Diagram (DFD) in Mermaid js syntax. Do not include parameters in function calls.
...@@ -52,16 +40,18 @@ This cheat sheet provides a concise reference for the syntax used in Mermaid flo ...@@ -52,16 +40,18 @@ This cheat sheet provides a concise reference for the syntax used in Mermaid flo
1. **Standard Node**: `id` 1. **Standard Node**: `id`
flowchart LR flowchart LR id
id
```
2. **Node with Text**: `id1[Text]` ```plaintext
flowchart LR
id1[This is text]
``` ```
2. **Node with Text**: `id1[Text]`
flowchart LR id1\[This is text\]
```plaintext
```
3. **Node Shapes**: 3. **Node Shapes**:
- **Round Edges**: `id1(Text)` - **Round Edges**: `id1(Text)`
- **Stadium Shape**: `id1([Text])` - **Stadium Shape**: `id1([Text])`
...@@ -97,7 +87,8 @@ This cheat sheet provides a concise reference for the syntax used in Mermaid flo ...@@ -97,7 +87,8 @@ This cheat sheet provides a concise reference for the syntax used in Mermaid flo
## Subgraphs ## Subgraphs
- Basic structure: - Basic structure:
```
```plaintext
subgraph title subgraph title
node definitions node definitions
end end
...@@ -124,18 +115,9 @@ This cheat sheet provides a concise reference for the syntax used in Mermaid flo ...@@ -124,18 +115,9 @@ This cheat sheet provides a concise reference for the syntax used in Mermaid flo
Given your example, here's the breakdown: Given your example, here's the breakdown:
flowchart LR flowchart LR A\[PostgresStorageConnector\] -- insert --> B((Database)) A -- get --> B A -- delete --> B A -- query --> B A -- get_all --> B C\[LanceDBConnector\] -- insert --> B C -- get --> B C -- delete --> B() C -- query --> B C -- get_all --> B
A[PostgresStorageConnector] -- insert --> B((Database))
A -- get --> B ```plaintext
A -- delete --> B
A -- query --> B
A -- get_all --> B
C[LanceDBConnector] -- insert --> B
C -- get --> B
C -- delete --> B()
C -- query --> B
C -- get_all --> B
```
- `A[PostgresStorageConnector]` and `C[LanceDBConnector]`: Nodes with text. - `A[PostgresStorageConnector]` and `C[LanceDBConnector]`: Nodes with text.
- `B((Database))`: Circle node with text. - `B((Database))`: Circle node with text.
...@@ -143,3 +125,4 @@ flowchart LR ...@@ -143,3 +125,4 @@ flowchart LR
- `-- get -->`, `-- delete -->`, `-- query -->`, `-- get_all -->`: Standard arrows. - `-- get -->`, `-- delete -->`, `-- query -->`, `-- get_all -->`: Standard arrows.
This syntax is valid in Mermaid and will create a flowchart with nodes and directed edges as described. This syntax is valid in Mermaid and will create a flowchart with nodes and directed edges as described.
```
\ No newline at end of file