Update README.md (#49)

* Update README.md * Update solidportal.md * Update README.md * Update solidportal.md * Update README.md
AI-Citizen · Sep 3, 2023 · caf4514 · caf4514
1 parent 65cf6d0
commit caf4514
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,6 @@ pip3 install -r requirements.txt #installing the env
 
 
 ## **Run Demo**
-
 **Acutal real start up project "AI Says" - stock analysis app dev workflow**
 include the brainstorming, write product requirement, write high level design, create kanban.
 ```sh
@@ -68,11 +67,15 @@ cd quickstart
 python3 creategraph.py webapp
 python3 quickstart.py webapp
 ```
->Default output path is SolidGPT/localstorage/workspace/out/<time - e.g. 202009011234>
+>The default initial iutput path is set to `SolidGPT/localstorage/workspace/in`. As part of the Demo, we have included two idea inputs in this location.
+
+>The default output path is set to `SolidGPT/localstorage/workspace/out/<time - e.g. 202009011234>`
 ## **Start Your Own Graph**
-0. (Optional) Customize your own agent and skill [(learn more)](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/customagentskill.md)
-1. Create a graph using Solid Portal. [(learn more)](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/solidportal.md). You can also create a graph json file by code. Please check `quickstart/creategraph.py` 
-2. Create an entry point located in the solidgpt folder and input the workgraph json file path
+0. (Optional) Customize your own agent and skill [(Learn more)](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/customagentskill.md)
+1. Create a graph using Solid Portal. [(Learn more)](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/solidportal.md).
+   You can also create a graph json file by code. Please check `quickstart/creategraph.py`
+1. Add your initial business idea into the input folder e.g. `SolidGPT/localstorage/workspace/in/your_initial_input_file.json`. Make sure the initial input folder path same with the graph first node input.param_path.
+1. Create an entry point located in the solidgpt folder and input the workgraph json file path
 ```python
 # your_file_name.py
 from solidgpt.src.orchestration.orchestration import *

diff --git a/docs/solidportal.md b/docs/solidportal.md
@@ -17,10 +17,19 @@ run `yarn start` which will also open your browser
 cd ..SolidGPT\solidportal\src and run `node uploadServer.js` to start file upload server on local, OR 
 you can manually upload file into SolidGPT\solidportal\src\uploads for Add node with input functions.
 
-### OR
+### Using our Server(Beta Test)
 If you don't want to run it on your local, we have host on our server. It is easier for you to test.
 [SolidPortal](http://154.16.118.231:8080/)   http://154.16.118.231:8080/(Beta test)
-Note: All users' customized skills will be shown in the Beta version. Make sure you have the json on your local for your customized skills. Basic skills are "Debug Code", "Write Code", "Write Product Requirement Documentation","Use Notion", "Write High Level Design", "Create Kanban Board", "Custom Skill", "Write lowdefy YAML", "Host and run web app".
+
+‼️ Note: All user-customized skills will be visible on the server. However, you can only employ both the basic skill and any custom skill if you possess the corresponding custom skill definition JSON file, located in your `localstorage/customizedskilldefinition` directory.
+Basic skills are 
+- "Debug Code"
+- "Write Code"
+- "Write Product Requirement Documentation","Use Notion"
+- "Write High Level Design", "Create Kanban Board"
+- "Custom Skill"
+- "Write lowdefy YAML"
+- "Host and run web app"
 
 # What is Work Graph
 The Work Graph comprises multiple nodes, each representing an agent skill. Every node concentrates on a specific task and shares the results with both the user and other agents.

diff --git a/solidportal/README.md b/solidportal/README.md
@@ -17,10 +17,18 @@ run `yarn start` which will also open your browser
 cd ..SolidGPT\solidportal\src and run `node uploadServer.js` to start file upload server on local, OR 
 you can manually upload file into SolidGPT\solidportal\src\uploads for Add node with input functions.
 
-### OR
+### Use our Server(Beta Test)
 If you don't want to run it on your local, we have host on our server. It is easier for you to test.
 [SolidPortal](http://154.16.118.231:8080/)   http://154.16.118.231:8080/(Beta test)
-Note: All users' customized skills will be shown in the Beta version. Make sure you have the json on your local for your customized skills. Basic skills are "Debug Code", "Write Code", "Write Product Requirement Documentation","Use Notion", "Write High Level Design", "Create Kanban Board", "Custom Skill", "Write lowdefy YAML", "Host and run web app".
+‼️ Note: All user-customized skills will be visible on the server. However, you can only employ both the basic skill and any custom skill if you possess the corresponding custom skill definition JSON file, located in your `localstorage/customizedskilldefinition` directory.
+Basic skills are 
+- "Debug Code"
+- "Write Code"
+- "Write Product Requirement Documentation","Use Notion"
+- "Write High Level Design", "Create Kanban Board"
+- "Custom Skill"
+- "Write lowdefy YAML"
+- "Host and run web app"
 
 # What is Work Graph
 The Work Graph comprises multiple nodes, each representing an agent skill. Every node concentrates on a specific task and shares the results with both the user and other agents.