From d53a8a81785f9877ed84aaa22df33701f1e9b477 Mon Sep 17 00:00:00 2001
From: yinxue <2643126914@qq.com>
Date: Fri, 1 Aug 2025 14:53:23 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                                     | 17 +++++++++++++++
 docs/document/decription/关于devstar.md       | 21 -------------------
 docs/document/{decription => }/devstar插件.md |  0
 docs/document/{decription => }/快速开始.md    |  0
 4 files changed, 17 insertions(+), 21 deletions(-)
 create mode 100644 README.md
 delete mode 100644 docs/document/decription/关于devstar.md
 rename docs/document/{decription => }/devstar插件.md (100%)
 rename docs/document/{decription => }/快速开始.md (100%)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba7a656
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# devstar介绍文档
+
+## 如何启动项目
+```md
+npm run docs:dev
+```
+## 如何打包项目
+```md
+npm run docs:build
+```
+## 如何预览项目
+```md
+npm run docs:preview
+```
+## 如何添加或修改目录
+在docs/.vitepress/config.mts中的sidebar进行修改，text为目录的描述内容，link为点击目录后加载的内容的链接，如果有子目录，在items进行修改
+link链接的内容既可以是网页链接，也可以是本地文档
diff --git a/docs/document/decription/关于devstar.md b/docs/document/decription/关于devstar.md
deleted file mode 100644
index a836f59..0000000
--- a/docs/document/decription/关于devstar.md
+++ /dev/null
@@ -1,21 +0,0 @@
----
-outline: deep
-weight: 1
----
-
-# 关于devstar
-
-DevStar Studio 是一个Gitea 发行版，在Git代码仓库托管的基础上提供了开发环境DevEnv执行引擎，与VS Code插件或自定义IDE深度融合，形成灵活适配基础软件工具的生态平台，从而为开发者用户提供智能（代码大模型AI+）、安全（完全云原生）、一站式开箱即用的CI/CD全生命周期研发平台。
-
-## 目标
-
-DevStar Studio是一个通用的一站式软件研发平台，它最初的目标是服务于汽车软件、消费电子、智能制造等嵌入式软件研发场景中的开发者
-
-## 在线演示
-
-访问[devstar.cn](https://devstar.cn)或者在VS Code插件市场搜索devstar
-
-
-
-
-
diff --git a/docs/document/decription/devstar插件.md b/docs/document/devstar插件.md
similarity index 100%
rename from docs/document/decription/devstar插件.md
rename to docs/document/devstar插件.md
diff --git a/docs/document/decription/快速开始.md b/docs/document/快速开始.md
similarity index 100%
rename from docs/document/decription/快速开始.md
rename to docs/document/快速开始.md