Skip to content

Commit 75109fb

Browse files
committed
update docs
1 parent 69844a2 commit 75109fb

File tree

3 files changed

+7
-36
lines changed

3 files changed

+7
-36
lines changed

docs/backend/reference/pk.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ ID 作为主键的默认声明方式=={.note}
4949
2. 更新所有 `id_key` 导入为 `snowflake_id_key`
5050
3. 执行 `backend/sql/init_snowflake_test_data.sql` 脚本初始化测试数据
5151

52-
::: caution Windows 平台警告
53-
如果您正在 Windows 平台中使用 mysql >= 8.0,还需要更新 `backend/database/db.py` 文件内的 `mysql+asyncmy`
54-
`mysql+aiomysql`,否则,您将无法在本地正常新增数据。相关
55-
issue:[asyncmy/issues/35](https://github.com/long2ice/asyncmy/issues/35)
56-
:::
52+
::: caution Windows 平台警告
53+
如果您正在 Windows 平台中使用 mysql >= 8.0,还需要更新 `backend/database/db.py` 文件内的 `mysql+asyncmy`
54+
`mysql+aiomysql`,否则,您将无法在本地正常新增数据。相关
55+
issue:[asyncmy/issues/35](https://github.com/long2ice/asyncmy/issues/35)
56+
:::
5757

5858
## 注意事项
5959

docs/backend/summary/quick-start.md

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
102102
```
103103
:::
104104

105-
9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选,三个都可以不执行" />
105+
9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选,可直接跳过" />
106106

107107
`backend` 目录打开终端,执行以下命令启动 celery 相关服务
108108

@@ -133,35 +133,6 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
133133
```shell:no-line-numbers
134134
fba run
135135
```
136-
137-
:::: details 附加说明
138-
此项目默认使用 CLI 启动服务,为了方便 Debug,你可以在 IDE 中直接右键运行 `run.py` 文件
139-
140-
需要注意的是,为了实现插件 0 耦合,插件依赖未使用 uv 进行管理。Debug 前请务必使用 `fba run` 命令启动一次服务,
141-
以便自动安装插件依赖
142-
143-
你也可以选择执行 `backend/scripts/init_plugin.py` 文件手动安装插件依赖
144-
145-
::: warning ModuleNotFoundError: No module named 'backend'
146-
147-
1. 自行搜索:将源根到添加到 PYTHONPATH
148-
2. 执行以下命令:
149-
150-
Linux/Mac:
151-
152-
```sh
153-
# 修改 /path/to/fba 为本地 fba 项目根路径
154-
export PYTHONPATH=$PYTHONPATH:/path/to/fba
155-
```
156-
157-
Windows(cmd):
158-
159-
```sh
160-
# 修改 D:\path\to\fba 为本地 fba 项目根路径
161-
set PYTHONPATH=%PYTHONPATH%;D:\path\to\fba
162-
```
163-
164-
:::
165136
::::
166137
167138
11. 初始化测试数据

docs/plugin/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: 插件安装
1414
1. 获取插件仓库源码并下载
1515
2. 将下载的源码文件夹直接拷贝到 `backend/plugin` 目录下
1616
3. 根据插件说明(README.md)进行相关配置
17-
4. 通过 CLI 重启服务
17+
4. 重启服务
1818

1919
@tab ZIP
2020

0 commit comments

Comments
 (0)