Skip to content

Commit

Permalink
README update (#62)
Browse files Browse the repository at this point in the history
  • Loading branch information
wwwwww1020 committed Oct 5, 2023
1 parent 5e0d19f commit 70ccbc4
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
# 🚀 What’s this
**V0.2.0:** Help you generate Product Requirement Document and Code Solution base on your private project with one line command.

# 🔥New Release: [SolidGPT Cloud Service](https://calm-flower-017281610.3.azurestaticapps.net/)
Just launched 🚀! Our Cloud Service lets you seamlessly integrate with your private project. Design, tech, and PRD solutions for your project - all with a simple click!
Get a personal AI for everyone! Boost your work like never before


### 🔥🔥 [Click to try SolidGPT Cloud Service!](https://calm-flower-017281610.3.azurestaticapps.net/)

>SolidGPT is a human-AI collaboration framework. Users can add private data and create their own agent workgraph using embedding finetuning and in-context learning simply with our framework. Our goal: empower AI to work with humans using tools to accomplish business tasks.
Expand Down
7 changes: 7 additions & 0 deletions docs/Introduction_CN_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@

>SolidGPT 是一个人工智能合作框架。用户可以添加私有数据并使用我们的框架简单地通过嵌入式微调和上下文学习创建自己的代理工作图。我们的目标:使用工具赋予AI与人类合作完成业务任务的能力。
# 🔥新发布: [SolidGPT 云服务](https://calm-flower-017281610.3.azurestaticapps.net/)
刚刚上线🚀!我们的云服务让您与您的私有后台无缝整合。为您的项目设计、技术和PRD解决方案
为每个人/企业提供私人AI!让人们的工作效率前所未有的提升。


### 🔥🔥 [点击试用SolidGPT云服务!](https://calm-flower-017281610.3.azurestaticapps.net/)

# 🏁 快速开始

## 🧱 **前提条件**
Expand Down
37 changes: 37 additions & 0 deletions docs/cloudserviceintro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<h1 align="center">🧱 SolidGPT Cloud Service</h1>

[![Twitter Follow](https://img.shields.io/twitter/follow/SolidGPT?style=social)](https://twitter.com/SolidGPT)
[![Static Badge](https://img.shields.io/badge/Github-SolidGPT-blue)](https://github.com/AI-Citizen/SolidGPT)



# 🚀 What’s this
Generate a Product Requirement Document and Code Solution that deeply integrates with your private project.

# 🏁 Quick Start
- SolidGPT first learns from your repository in the `Onboard Project` phase.

- After this, choose Generate PRD or Get Tech Solution for customized solutions based on the onboarded project.

## 📖 Onborading your project

1. Choose `Onboard Project` from the top left dropdown.
1. Enter your OpenAI API key.
1. Upload your project folder.
1. Note the `Most Recent Repo ID`. (Automatically used later; save for future actions to skip onboarding.)

## 🧮 Get Technical Solution
1. Choose `Get Tech Solution` from the top left dropdown.
1. Enter your OpenAI API key.
1. Input your problem/Requirement.

## 📁 Generate Product Requirement Document
1. Choose `Generate RPD` from the top left dropdown.
1. input your requirement (suggest short and clear)
1. input additional info or your project, SolidGPT will use both summary from repository and additional info you provided (optinoal)

## 📣 Feedback!!
If you have any questions or feedback about our project, please don't hesitate to reach out to us. We greatly appreciate your suggestions!
- Email: aict@ai-citi.com
- GitHub Issues: For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/AI-Citizen/SolidGPT/issues).
We will respond to all questions within 2-3 business days.
34 changes: 34 additions & 0 deletions docs/cloudserviceintro_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<h1 align="center">🧱 SolidGPT 云服务</h1>

[![Twitter Follow](https://img.shields.io/twitter/follow/SolidGPT?style=social)](https://twitter.com/SolidGPT)
[![Static Badge](https://img.shields.io/badge/Github-SolidGPT-blue)](https://github.com/AI-Citizen/SolidGPT)

# 🚀 这是什么?
基于您的私有项目深度集成来生成产品需求文档和代码方案。

# 🏁 快速开始
- SolidGPT 首先学习您的仓库,在 `Onboard Project` 阶段。

- 之后,请选择 Generate PRD 或 Get Tech Solution,根据已上载的项目为您提供定制的解决方案。

## 📖 为您的项目上载
1. 从左上角的下拉菜单中选择 `Onboard Project`
1. 输入您的 OpenAI API 密钥。
1. 上传您的项目文件夹。
1. 记录 `Most Recent Repo ID`。 (之后会自动使用; 保存以在未来的操作中跳过上载。)

## 🧮 获取技术方案
1. 从左上角的下拉菜单中选择 `Get Tech Solution`
1. 输入您的 OpenAI API 密钥。
1. 输入您的问题/需求。

## 📁 生成产品需求文档
1. 从左上角的下拉菜单中选择 `Generate RPD`
1. 输入您的需求 (建议简短明了)
1. 输入您的项目的附加信息,SolidGPT 会使用仓库的摘要和您提供的附加信息(可选)

## 📣 反馈!!
如果您对我们的项目有任何疑问或反馈,请随时与我们联系。我们非常感谢您的建议!
- 邮箱: aict@ai-citi.com
- GitHub 问题: 对于更技术性的咨询,您也可以在我们的 [GitHub 仓库](https://github.com/AI-Citizen/SolidGPT/issues)中创建一个新问题。
我们将在2-3个工作日内回复所有问题。

0 comments on commit 70ccbc4

Please sign in to comment.