Skip to content

Commit

Permalink
update all readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yhbcode000 committed Dec 2, 2024
1 parent d64ead9 commit 46df9a1
Show file tree
Hide file tree
Showing 12 changed files with 801 additions and 49 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 🌌 MultiverseNote



## 📖 Introduction

MultiverseNote is an open-source project aimed at transforming AI chatbot interactions into structured project management workflows. This initiative enhances knowledge management and version control by converting traditional dialogue into a project-focused format. Through the introduction of a branch management system, users can discuss topics on the main branch and initiate new branches for in-depth exploration when problems arise. This allows for systematic and continuous knowledge development.
Expand Down Expand Up @@ -38,7 +40,6 @@ For contact information and further details, email [[email protected]](mail
## 📚 Table of Contents

- [Getting Started](docs/en/getting_started.md)
- [Installation Guide](docs/en/installation_guide.md)
- [User Manual](docs/en/user_manual.md)
- [Developer Documentation](docs/en/developer_documentation.md)
- [FAQ and Troubleshooting](docs/en/faq_and_troubleshooting.md)
Expand Down
59 changes: 58 additions & 1 deletion README_zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,60 @@
# 🌌 MultiverseNote

中文版待更新
## 📖 简介

MultiverseNote 是一个开源项目,旨在将 AI 聊天机器人交互转换为结构化的项目管理工作流。通过将传统对话转化为面向项目的格式,该项目提升了知识管理和版本控制能力。MultiverseNote 引入了分支管理系统,用户可以在主分支上讨论话题,并在出现问题时创建新分支进行深入探索,从而实现系统化和持续的知识开发。

该项目提供直观的界面,用于显示所有分支并通过拖放方式进行管理。**最小可行产品 (MVP)** 包括通过编号(如 123 或 145)识别和合并分支的功能。

MultiverseNote 满足了 AI 聊天机器人环境中对有序且持久的结构需求,确保讨论能够演变为完整的项目叙事。

---

## 💻 平台与开发环境

- **前端**
- 使用 Python 中的 **Taipy** 开发,简化了 AI 驱动工作流的前端开发。
- 提供 API 用于与外部前端工具集成,确保灵活性和兼容性。

- **后端**
- 通过 AI 驱动的组件进行全面管理。包括嵌入服务和记忆服务在内的所有功能均实现为 **LLM 工具**

- **支持操作系统**:Windows、macOS、Linux

---

## 🤝 如何加入

我们欢迎对 AI 聊天机器人、项目管理以及将对话模型转化为结构化工作流感兴趣的开发者和贡献者加入 MultiverseNote。您可以通过以下方式参与:

1. 查看我们的 [Issues](#) 页面了解需要帮助的当前任务。
2. 通过 Fork 和 Pull Request 提交您的贡献。
3. 加入社区讨论,分享想法并改进项目。

如需联系和了解更多信息,请发送邮件至 [[email protected]](mailto:[email protected])

---

## 📚 内容目录

- [快速入门](docs/zh/getting_started.md)
- [用户手册](docs/zh/user_manual.md)
- [开发者文档](docs/zh/developer_documentation.md)
- [常见问题与故障排查](docs/zh/faq_and_troubleshooting.md)

---

## 🛠 开发计划

项目的发展包含以下计划里程碑:

1. **API 开放**:优化和完善 API 接口文档,支持与外部前端无缝集成。
2. **AI 驱动管理**:增强嵌入、记忆和工作流管理的 LLM 工具。
3. **分支与工作流可视化**:扩展分支可视化和合并的拖放功能。
4. **可扩展性**:优化后端系统以高效处理大规模项目和数据集。

---

## 📜 开源许可证

本项目根据 Apache License 2.0 发布。详情请参阅 [LICENSE](LICENSE) 文件。
326 changes: 326 additions & 0 deletions docs/drawio/app_structure.drawio

Large diffs are not rendered by default.

62 changes: 30 additions & 32 deletions docs/en/developer_documentation.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,57 @@
# Developer Documentation for MultiverseNote

## Project Roadmap
```mermaid
graph LR
A[Phase 1: Minimum Viable Product MVP] --> B[Phase 2: Backend Development]
B --> C[Phase 3: Taipy UI Refinement]
```

Welcome to the MultiverseNote Developer Documentation. This document outlines the roadmap for the project, detailing stages and key milestones that will guide our development from inception to the full release.

### Overview
![1733164043434.png](https://image.discover304.top/1733164043434.png)

MultiverseNote aims to transform AI chatbot interactions into structured project management workflows. The development is structured into several key phases, each building upon the previous to gradually increase functionality and user engagement.

### Phase 1: Minimum Viable Product (MVP)
## Project Roadmap

**Objective**: Establish basic functionality using React Native to handle simple project management tasks and branching dialogues.
Welcome to the MultiverseNote Developer Documentation. This document outlines the roadmap for the project, detailing stages and key milestones that will guide our development from inception to full release.

- **Frontend**: Develop the initial user interface using React Native without a backend integration. Focus on basic app components such as project listing, branch creation, and basic navigation.
- **Core Features**: User authentication, project creation, and simple branching mechanics.
- **Timeline**: Q3 2024
## Overview

### Phase 2: Utools Plugin
MultiverseNote aims to transform AI chatbot interactions into structured project management workflows. The development is structured into several key phases, each building upon the previous one to gradually increase functionality and user engagement.

**Objective**: Extend functionality by integrating with Utools to provide enhanced utility through plugins.
## Phase 1: Minimum Viable Product (MVP)

- **Plugin Development**: Create a plugin for Utools that allows users to interact with MultiverseNote directly from other tools.
- **Integration Testing**: Ensure seamless functionality between the plugin and the main app.
- **Timeline**: Q4 2024
**Objective**: Establish basic functionality using Taipy to handle simple project management tasks and branching dialogues.

### Phase 3: Terminal Application
- **System Design**: Develop the initial user interface using Taipy, integrating both UI and backend functionality.
- **Core Features**: User authentication, project creation, and simple branching mechanics.
- **Timeline**: Q3 2024

## Phase 2: Backend Development

**Objective**: Develop a terminal-based application for advanced users who prefer command-line tools over graphical interfaces.
**Objective**: Develop a comprehensive backend system to support extensive project management features.

- **Backend Setup**: Establish a simple server using Node.js to handle API requests.
- **CLI Development**: Implement a command-line interface that mirrors the functionality of the GUI.
- **Database Integration**: Set up a robust database system to manage complex data and user interactions.
- **Backend Logic**: Develop complex backend logic to handle multiple users, extensive data processing, and security measures.
- **API Server**: Develop an API server to facilitate communication between different parts of the system.
- **Timeline**: Q1 2025

### Phase 4: Full Frontend Development
## Phase 3: Taipy UI Refinement

**Objective**: Enhance the frontend with more advanced features and prepare for backend integration.
**Objective**: Refine the UI using Taipy as part of the whole system design, ensuring that the backend and UI work cohesively.

- **Advanced UI/UX**: Implement more sophisticated UI elements and user interaction capabilities.
- **Performance Optimization**: Enhance application responsiveness and data handling.
- **UI Development**: Enhance the user-friendly interface using Taipy, improving usability and visual design.
- **System Testing**: Ensure that all components work well together in the unified system.
- **Timeline**: Q2 2025

### Phase 5: Full Backend Development

**Objective**: Develop a comprehensive backend system to support extensive project management features.

- **Database Integration**: Set up a robust database system to manage complex data and user interactions.
- **Backend Logic**: Develop complex backend logic to handle multiple users, extensive data processing, and security measures.
- **Timeline**: Q3-Q4 2025

## Future Milestones

- **Beta Testing**: Involve users in testing the integrated frontend and backend to refine features and UI.
- **Frontend Development with Latest Framework**: As part of future work, develop a modern frontend using the latest frameworks to enhance user experience and compatibility.
- **Utools Integration**: Integrate Taipy-based UI with Utools for enhanced functionality and accessibility.
- **Beta Testing**: Involve users in testing the integrated system to refine features and improve the user interface.
- **Release Candidate**: Prepare and polish the final version for public release.
- **Official Launch**: Launch the fully integrated system with comprehensive support for multiple platforms.

## Conclusion

This roadmap provides a structured approach to developing MultiverseNote, with clear objectives and timelines to guide our progress. By adhering to this plan, we aim to create a robust platform that fulfills the needs of managing AI-enhanced project conversations efficiently.
This roadmap provides a structured approach to developing MultiverseNote, with clear objectives and timelines to guide our progress. By adhering to this plan, we aim to create a robust platform that integrates all components efficiently, facilitating AI-enhanced project conversations through a unified system design.

20 changes: 12 additions & 8 deletions docs/en/faq_and_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,30 @@

### 2. Why is version control of AI chat histories important for project-wise development?

The ability to version control AI chat histories is pivotal for project management as it ensures that conversations can be archived, traced back, and built upon over time. Traditional chat patterns lack this capability, often resulting in the loss of valuable context and details necessary for understanding evolving project dynamics. Version controlling conversations allow for a detailed and historical perspective essential for long-term project success.
The ability to version control AI chat histories is pivotal for project management as it ensures that conversations can be archived, traced back, and built upon over time. Traditional chat patterns lack this capability, often resulting in the loss of valuable context and details necessary for understanding evolving project dynamics. Version controlling conversations allows for a detailed and historical perspective essential for long-term project success.

### 3. Why is our project focused on frontend development, and what backend services do we plan to use?
### 3. Why is our project focused on system integration with Taipy, and what backend services do we plan to use?

Initially, **MultiverseNote** emphasizes frontend development to ensure a responsive and intuitive user interface. For backend functionalities, we intend to utilize powerful APIs, specifically the ChatGPT API for handling sophisticated data processing and AI interactions. This approach allows us to maintain a lightweight frontend while leveraging advanced backend capabilities provided by leading AI technologies.
Initially, **MultiverseNote** emphasizes integrating the entire system using **Taipy**. Taipy serves as both the frontend and UI framework, allowing for a cohesive experience with the backend. Our backend development includes robust database systems and API servers to support extensive project management. The backend logic is developed to manage multiple users, data processing, and ensure security.

### 4. Who are we, and why are we undertaking this project?

AIerLab consists of a dedicated team of researchers and developers with diverse backgrounds from prestigious global institutions. Our commitment is to advance AI applications in ways that are safe, user-friendly, and aligned with high standards of privacy and governance. MultiverseNote is a direct reflection of our goal to make AI more accessible and practical for everyday project management tasks, enhancing user experience and operational efficiency.
**AierLab** consists of a dedicated team of researchers and developers with diverse backgrounds from prestigious global institutions. Our commitment is to advance AI applications in ways that are safe, user-friendly, and aligned with high standards of privacy and governance. MultiverseNote is a direct reflection of our goal to make AI more accessible and practical for everyday project management tasks, enhancing user experience and operational efficiency.

### 5. What are the future plans for the frontend of MultiverseNote?

As part of future development, we plan to enhance the frontend using the latest web frameworks. This will be part of a continued effort to provide a responsive and visually appealing user experience. The integration with Utools will also be an important aspect of future updates, making MultiverseNote more accessible from different environments.

## Troubleshooting

### Overview of Common Issues

This section will continually evolve as we gather common issues encountered by our users. For now, here are a few troubleshooting tips:

- **Installation Challenges**: Make sure your environment aligns with our specified prerequisites. Check for common errors like permissions or network configurations.
- **React Native Errors**: Confirm that all dependencies are correctly installed. Refer to specific error logs and React Native’s extensive documentation for guidance.
- **API Connectivity**: Ensure your API keys for ChatGPT are correctly set up and that there are no network issues affecting connectivity.
- **Installation Challenges**: Make sure your environment aligns with our specified prerequisites. Ensure Python 3.8+ is installed and that `uv sync` has been successfully run to synchronize project dependencies. If issues persist, ensure that you have activated the virtual environment correctly.
- **API Connectivity**: Ensure your API server is running correctly and that there are no network issues affecting connectivity. Verify that the API keys for ChatGPT or any other required services are properly set up.

### Ongoing Updates

We will update this section regularly based on the issues raised in our GitHub repository. Keep an eye on this document and our project updates for the latest solutions and troubleshooting advice.
We will update this section regularly based on the issues raised in our GitHub repository. Keep an eye on this document and our project updates for the latest solutions and troubleshooting advice.

1 change: 0 additions & 1 deletion docs/en/installation_guide.md

This file was deleted.

13 changes: 7 additions & 6 deletions docs/en/user_manual.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# User Manual for MultiverseNote

## Coming Soon
## Under Construction

Welcome to the early stages of MultiverseNote, a groundbreaking project aimed at transforming the way AI chatbot interactions are structured into project management workflows.

### What to Expect

The User Manual will be comprehensive and designed to assist users in navigating MultiverseNote effectively. Upon completion, the manual will include:
The User Manual is currently under construction as our project progresses through its development stages. Once completed, it will be a comprehensive guide to assist users in effectively navigating MultiverseNote. The manual will include:

- **Getting Started**: Quick start guide to help you set up and begin using MultiverseNote.
- **Features Overview**: Detailed explanations of all features and how to use them to manage projects and conversations.
- **Best Practices**: Tips and tricks on how to maximize efficiency using MultiverseNote.
- **Troubleshooting**: Common issues and their solutions to help you resolve any problems quickly.
- **Getting Started**: A quick start guide to help you set up and begin using MultiverseNote.
- **Features Overview**: Detailed explanations of all features and instructions on how to use them to manage projects and conversations.
- **Best Practices**: Tips and tricks to help you maximize efficiency when using MultiverseNote.
- **Troubleshooting**: Common issues and their solutions to help you resolve problems quickly and smoothly.

### Stay Updated

Expand All @@ -25,3 +25,4 @@ We value your interest and support as we develop MultiverseNote and are excited
## Contact Us

If you have questions or require further information in the meantime, feel free to contact us at [[email protected]](mailto:[email protected]). We are eager to assist and ensure your experience is smooth and beneficial.

64 changes: 64 additions & 0 deletions docs/zh/developer_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# MultiverseNote 开发者文档

```mermaid
graph LR
A[阶段 1:最小可行产品 MVP] --> B[阶段 2:后端开发]
B --> C[阶段 3:Taipy 界面优化]
```

![1733163863736.png](https://image.discover304.top/1733163863736.png)

## 项目路线图

欢迎阅读 MultiverseNote 开发者文档。本文件概述了项目的路线图,详细说明了从初期构想到正式发布过程中各个阶段和关键里程碑。

## 概述

MultiverseNote 旨在将 AI 聊天机器人交互转化为结构化的项目管理工作流。开发分为多个关键阶段,每个阶段在前一个阶段的基础上逐步提升功能和用户参与度。

---

## 阶段 1:最小可行产品 (MVP)

**目标**:使用 Taipy 构建基本功能,处理简单的项目管理任务和分支对话。

- **系统设计**:利用 Taipy 开发初始用户界面,整合 UI 和后端功能。
- **核心功能**:用户认证、项目创建以及简单的分支管理机制。
- **时间节点**:2024 年第 3 季度

---

## 阶段 2:后端开发

**目标**:开发支持丰富项目管理功能的全面后端系统。

- **数据库集成**:建立强大的数据库系统,用于管理复杂数据和用户交互。
- **后端逻辑**:开发复杂的后端逻辑,支持多用户、广泛的数据处理以及安全措施。
- **API 服务**:开发 API 服务,用于系统各部分之间的通信。
- **时间节点**:2025 年第 1 季度

---

## 阶段 3:Taipy 界面优化

**目标**:使用 Taipy 优化界面设计,确保后端和界面协调运作。

- **界面开发**:基于 Taipy 改善用户界面,提高可用性和视觉设计。
- **系统测试**:确保所有组件在统一系统中协同工作。
- **时间节点**:2025 年第 2 季度

---

## 未来里程碑

- **前端开发(使用最新框架)**:作为未来工作的一部分,使用最新框架开发现代前端,提升用户体验和兼容性。
- **Utools 集成**:将基于 Taipy 的界面与 Utools 集成,以增强功能和可访问性。
- **Beta 测试**:邀请用户测试集成系统,优化功能并改进用户界面。
- **候选版本**:准备和完善最终版本以供公众使用。
- **正式发布**:推出支持多平台的完整集成系统,并提供全面支持。

---

## 结论

此路线图为开发 MultiverseNote 提供了清晰的目标和时间规划。通过遵循此计划,我们旨在创建一个高效整合所有组件的平台,利用统一的系统设计促进 AI 增强的项目对话。
Loading

0 comments on commit 46df9a1

Please sign in to comment.