docs: 核查并润色文档,对齐项目实际实现

- 删除未经验证的环境要求(Docker 版本号、浏览器条目)与括号废话
- 故障排查改为真实处理路径(升级→重新发布→强制同步→重建 Agent→提交 issue),删除仅开发时用的排障章节
- 删除设计文档中的测试与验收、实现检查清单、贡献者阅读建议等开发内容
- 修正与代码不符的事实:reset-passwd 命令名、证书续签窗口 7 天、Pages 检查间隔 1440 分钟、Relay vhost 端口 8080、SSO 仅支持 OIDC 等
- 去除口语化表述与无意义括号,改写「不是…而是…」句式
- 同步修正文档站链接锚点,构建验证通过
This commit is contained in:
ryan
2026-08-16 17:49:57 +08:00
parent 4e3d79c001
commit 600a7acdfb
37 changed files with 275 additions and 517 deletions
+8 -7
View File
@@ -24,7 +24,7 @@ go run main.go scheduler # 仅定时任务调度
编译二进制:
```bash
make build-server
make build-backend
# 产物:bin/openflare-server
```
@@ -40,13 +40,13 @@ GOCACHE=/tmp/openflare-go-cache go test ./...
make code-check
```
自动格式化后端 Go 与前端 TypeScript、JavaScript、CSS 等源码:
自动格式化后端 Go 源码(整理导入)与前端源码:
```bash
make prettier
make format
```
该命令使用 `gofmt` 格式化后端,并使用项目固定版本的 Prettier 格式化 `frontend/` 源码;构建产物、依赖、公开静态资源和锁文件会被忽略。
该命令使用 `goimports` 整理后端 Go 源码导入,并使用项目固定版本的 Prettier 格式化 `frontend/` 源码;构建产物、依赖、公开静态资源和锁文件会被忽略。
## Frontend
@@ -71,7 +71,8 @@ pnpm build:embed
```bash
cd frontend
pnpm lint
pnpm typecheck
pnpm tsc --noEmit --jsx preserve
pnpm check:i18n
```
## Agent
@@ -147,7 +148,7 @@ curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/unin
make swagger
```
访问:`http://localhost:3000/swagger/index.html`
访问:`http://localhost:3000/api/swagger/index.html`(默认 `api_prefix` 为 `/api`,仅非生产环境挂载)
## Docs
@@ -162,5 +163,5 @@ pnpm dev
```bash
cd docs
pnpm build:embed
pnpm build
```