chore: update project name to ChocoBuilder

Update project name and references from "Chocolate Factory" to "ChocoBuilder" for consistency. This commit modifies various files, including UI components, documentation, test cases, and configuration files, to reflect the new project name "ChocoBuilder" instead of "Chocolate Factory."
unit-mesh · Jul 7, 2024 · 7ad0b33 · 7ad0b33
1 parent f2c4061
commit 7ad0b33
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <p align="center">
   <a href="https://framework.unitmesh.cc/"><img src="docs/logo.svg" alt="Logo" height=170></a>
 </p>
-<h1 align="center">Chocolate Factory</h1>
+<h1 align="center">ChocoBuilder (aka Chocolate Factory)</h1>
 
 <p align="center">
 <img src="https://img.shields.io/github/stars/unit-mesh/chocolate-factory" alt="stars">
@@ -12,9 +12,9 @@
 
 [Read the docs →](https://framework.unitmesh.cc/)
 
-## What is Chocolate Factory?
+## What is ChocoBuilder?
 
-> Chocolate Factory 是一款开源的 LLM 应用开发框架，旨在帮助您轻松打造强大的软件开发 SDLC + LLM 生成助手。
+> ChocoBuilder (origin Chocolate Factory) 是一款开源的 LLM 应用开发框架，旨在帮助您轻松打造强大的软件开发 SDLC + LLM 生成助手。
 
 For native (Android/iOS/Embedded device) SDK:
 see in [https://github.com/unit-mesh/edge-infer](https://github.com/unit-mesh/edge-infer)
@@ -93,9 +93,9 @@ See in [https://framework.unitmesh.cc/](https://framework.unitmesh.cc/) or see i
 
 ## Design Philosophy: Domain Driven Problem-Solving
 
-The key concepts of Chocolate Factory are:
+The key concepts of ChocoBuilder are:
 
-![Chocolate Factory Concepts](docs/images/chocolate-factory.svg)
+![ChocoBuilder Concepts](docs/images/chocolate-factory.svg)
 
 (PS: Origin made by Michael Plöd
 at [Aligning organization and architecture with strategic DDD](https://speakerdeck.com/mploed/aligning-organization-and-architecture-with-strategic-ddd))
@@ -110,7 +110,7 @@ A user's problem is processed by the following steps:
 
 - Online Demo: [https://framework.unitmesh.cc/](https://framework.unitmesh.cc/) (TODO)
 - Video Demo: [https://www.bilibili.com/video/BV1T14y1C7p2](https://www.bilibili.com/video/BV1T14y1C7p2)
-- Gif Demo: ![Chocolate Factory Demo](https://unitmesh.cc/cf/testcase-demo.gif)
+- Gif Demo: ![ChocoBuilder Demo](https://unitmesh.cc/cf/testcase-demo.gif)
 
 ### Example 1: Frontend Screenshot
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -74,7 +74,7 @@ configure(
                 }
                 pom {
                     name.set("ChocolateFactory")
-                    description.set("Chocolate Factory is a cutting-edge LLM toolkit designed to empower you in creating your very own AI assistant.")
+                    description.set("ChocoBuilder is a cutting-edge LLM toolkit designed to empower you in creating your very own AI assistant.")
                     url.set("https://framework.unitmesh.cc/")
                     licenses {
                         license {

diff --git a/choc-ui/app/layout.tsx b/choc-ui/app/layout.tsx
@@ -11,10 +11,10 @@ import { Header } from '@/components/header'
 
 export const metadata: Metadata = {
   title: {
-    default: 'Chocolate Factory',
-    template: `%s - Chocolate Factory`
+    default: 'ChocoBuilder',
+    template: `%s - ChocoBuilder`
   },
-  description: ' Chocolate Factory is a cutting-edge LLM application engine designed to empower you in creating your very own AI assistant. ',
+  description: ' ChocoBuilder is a cutting-edge LLM application engine designed to empower you in creating your very own AI assistant. ',
   themeColor: [
     { media: '(prefers-color-scheme: light)', color: 'white' },
     { media: '(prefers-color-scheme: dark)', color: 'black' }

diff --git a/choc-ui/components/empty-screen.tsx b/choc-ui/components/empty-screen.tsx
@@ -25,7 +25,7 @@ export function EmptyScreen({ setDomain, setInput }: EmptyScreenType) {
     <div className="mx-auto max-w-2xl px-4">
       <div className="rounded-lg border bg-background p-8">
         <h1 className="mb-2 text-lg font-semibold">
-          Welcome to use Chocolate Factory!
+          Welcome to use ChocoBuilder!
         </h1>
         <p className="mb-2 leading-normal text-muted-foreground">
           This is an open source LLM application engine designed to empower you

diff --git a/choc-ui/components/flow/use-chat.ts b/choc-ui/components/flow/use-chat.ts
@@ -328,7 +328,7 @@ const getStreamedResponse = async (
 
         if (!line) return
 
-        // Chocolate Factory custom response
+        // ChocoBuilder custom response
         try {
           let parsed: MessageResponse | any
           try {

diff --git a/choc-ui/components/footer.tsx b/choc-ui/components/footer.tsx
@@ -15,7 +15,7 @@ export function FooterText({ className, ...props }: React.ComponentProps<'p'>) {
     >
       Open source LLM helper factor built with{' '}
       <ExternalLink href="https://github.com/unit-mesh/chocolate-factory">
-        Chocolate Factory
+        ChocoBuilder
       </ExternalLink>
       .
     </p>

diff --git a/choc-ui/components/header.tsx b/choc-ui/components/header.tsx
@@ -10,7 +10,7 @@ export async function Header() {
     <header className="sticky top-0 z-50 flex items-center justify-between w-full h-16 px-4 border-b shrink-0 bg-gradient-to-b from-background/10 via-background/50 to-background/80 backdrop-blur-xl">
       <div className="flex items-center">
         <Link href="/" target="_blank" rel="nofollow">
-          Chocolate Factory
+          ChocoBuilder
         </Link>
       </div>
       <div className="flex items-center justify-end space-x-2">

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,7 +1,7 @@
 remote_theme: pmarsceill/just-the-docs
 
-title: Chocolate Factory
-description: Chocolate Factory 是一款开源的 AI Agent 开发引擎/数据框架（Toolkit），旨在帮助您轻松打造强大的 LLM 助手。无论您是需要生成前端页面、后端 API、SQL 图表，还是测试用例数据，Chocolate Factory 都能满足您的需求。
+title: ChocoBuilder
+description: ChocoBuilder 是一款开源的 AI Agent 开发引擎/数据框架（Toolkit），旨在帮助您轻松打造强大的 LLM 助手。无论您是需要生成前端页面、后端 API、SQL 图表，还是测试用例数据，ChocoBuilder 都能满足您的需求。
 
 heading_anchors: true
 

diff --git a/docs/home.md b/docs/home.md
@@ -1,15 +1,15 @@
 ---
 layout: default
 title: Home
-description: Chocolate Factory 是一款开源的 LLM 应用开发框架，旨在帮助您轻松打造强大的软件开发 SDLC + LLM 生成助手。
+description: ChocoBuilder 是一款开源的 LLM 应用开发框架，旨在帮助您轻松打造强大的软件开发 SDLC + LLM 生成助手。
 nav_order: 1
 permalink: /
 ---
 
 <p align="center">
   <a href="https://framework.unitmesh.cc/"><img src="logo.svg" alt="Logo" height=170></a>
 </p>
-<h1 align="center">Chocolate Factory</h1>
+<h1 align="center">ChocoBuilder (aka Chocolate Factory)</h1>
 
 <p align="center">
 <img src="https://img.shields.io/github/stars/unit-mesh/chocolate-factory" alt="stars">
@@ -18,9 +18,9 @@ permalink: /
 <a href="https://central.sonatype.com/namespace/cc.unitmesh"><img src="https://img.shields.io/maven-central/v/cc.unitmesh/cocoa-core"  alt="Maven"/></a>
 </p>
 
-# What is Chocolate Factory?
+# What is ChocoBuilder?
 
-> Chocolate Factory 是一款开源的 LLM 应用开发框架，旨在帮助您轻松打造强大的软件开发 SDLC + LLM 生成助手。
+> ChocoBuilder (aka Chocolate Factory) 是一款开源的 LLM 应用开发框架，旨在帮助您轻松打造强大的软件开发 SDLC + LLM 生成助手。
 
 
 For native (Android/iOS/Embedded device) SDK:
@@ -98,9 +98,9 @@ Android:
 
 ## 设计理念：领域驱动的问题求解
 
-Chocolate Factory 是基于领域驱动设计思想的，如下图所示：
+ChocoBuilder 是基于领域驱动设计思想的，如下图所示：
 
-![Chocolate Factory Concepts](images/chocolate-factory.svg)
+![ChocoBuilder Concepts](images/chocolate-factory.svg)
 
 > 软件系统的构建实则是对问题空间的求解，以此获得构建解空间的设计方案。 —— 《解构领域驱动设计》
 

diff --git a/docs/modules/code-splitter.md b/docs/modules/code-splitter.md
@@ -32,7 +32,7 @@ Code Splitter 模块是一个代码分割模块，用于将代码分割成多个
 - 基于规则 DSL的语法分析：LlamaIndex
     - TreeSitter: [https://tree-sitter.github.io/tree-sitter/](https://tree-sitter.github.io/tree-sitter/)
 
-## Chocolate Factory 实现
+## ChocoBuilder 实现
 
 Chunk/Document 拆分策略
 

diff --git a/docs/modules/local-embedding.md b/docs/modules/local-embedding.md
@@ -19,7 +19,7 @@ Local Embedding
 > 文本分类、聚类等。它是通过预训练的深度学习模型实现的，通常使用诸如BERT、RoBERTa、DistilBERT等预训练模型作为其基础架构。
 
 在这里，我们使用的 SentenceTransformers 模型是：[sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2)， 
-在体积上只有 22M，因此被 Bloop、GitHub Copilot 作为本地向量化模型，也因此是 Chocolate Factory 的默认的本地矢量化模块。
+在体积上只有 22M，因此被 Bloop、GitHub Copilot 作为本地向量化模型，也因此是 ChocoBuilder 的默认的本地矢量化模块。
 
 - all-MiniLM-L6-v2 支持转为 384 维稠密向量空间（dimensional dense vector space），即 384 
 

diff --git a/docs/patterns/hyde.md b/docs/patterns/hyde.md
@@ -24,7 +24,7 @@ HyDE 由三个步骤组成：
 
 ## 示例
 
-Chocolate Factory 实现示例：
+ChocoBuilder 实现示例：
 
 ```kotlin
 ExplainQuery(

diff --git a/docs/rag/splitter.md b/docs/rag/splitter.md
@@ -20,7 +20,7 @@ nav_order: 2
     - 取决于问答的文本的长度和复杂度：最好问答的文本长度和分块的尺寸差不多，这样会对检索效率更友好；
     - 应用类型：根据不同的 RAG 类型（如检索、问答和摘要等），都会对分块策略有不同的影响。
 
-在 Chocolate Factory 中，我们会结合代码的特点，使用不同的分块策略，再结合固定大小的分块方式，来进行分块。
+在 ChocoBuilder 中，我们会结合代码的特点，使用不同的分块策略，再结合固定大小的分块方式，来进行分块。
 
 ## Code Splitter
 

diff --git a/docs/workflow/workflow-development.md b/docs/workflow/workflow-development.md
@@ -9,7 +9,7 @@ nav_order: 1
 
 ## 1. 声明 Domain
 
-Chocolate Factory 通过反射来加载 Domain，所以需要在 `cc.unitmesh.cf.domains` 目录下声明 Domain。诸如于：
+ChocoBuilder 通过反射来加载 Domain，所以需要在 `cc.unitmesh.cf.domains` 目录下声明 Domain。诸如于：
 
 ```kotlin
 @Component

diff --git a/...odules/document/src/test/kotlin/cc/unitmesh/document/parser/MsOfficeDocumentParserTest.kt b/...odules/document/src/test/kotlin/cc/unitmesh/document/parser/MsOfficeDocumentParserTest.kt
@@ -18,6 +18,6 @@ class MsOfficeDocumentParserTest {
         val inputStream = this.javaClass.getResourceAsStream("/ChocolateFactory.docx")!!
         val documents = MsOfficeDocumentParser(DocumentType.DOC).parse(inputStream)
 
-        assert(documents[0].text.contains("Chocolate Factory"))
+        assert(documents[0].text.contains("ChocoBuilder"))
     }
 }