Skip to content

Commit 94e1666

Browse files
JacobinwweyJacobinwwey
committed
feat: release v1.6.6 provider runtime and toml unified settings
1 parent a981bde commit 94e1666

37 files changed

Lines changed: 2922 additions & 523 deletions

‎.github/workflows/docs-edgeone-publish.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: Docs EdgeOne Publish
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
paths:
9+
- "docs/**"
10+
- "mkdocs.yml"
11+
- "docs/requirements-mkdocs.txt"
12+
- "scripts/deploy-docs-edgeone.js"
13+
- "scripts/run-mkdocs.js"
14+
- "package.json"
15+
- "package-lock.json"
16+
- "README.md"
17+
- ".github/workflows/docs-edgeone-publish.yml"
18+
workflow_dispatch:
19+
inputs:
20+
source_ref:
21+
description: "Branch, tag, or commit to publish from (for rollback)"
22+
required: false
23+
type: string
24+
deploy_env:
25+
description: "Deploy environment"
26+
required: false
27+
default: production
28+
type: choice
29+
options:
30+
- production
31+
- preview
32+
deploy_area:
33+
description: "Deploy area"
34+
required: false
35+
default: global
36+
type: choice
37+
options:
38+
- global
39+
- overseas
40+
project_name:
41+
description: "Override EdgeOne Pages project name"
42+
required: false
43+
type: string
44+
45+
env:
46+
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
47+
48+
jobs:
49+
docs-edgeone-publish:
50+
name: docs-edgeone-publish
51+
runs-on: ubuntu-latest
52+
53+
steps:
54+
- name: Checkout repository
55+
uses: actions/checkout@v5
56+
with:
57+
ref: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.source_ref != '' && github.event.inputs.source_ref || github.ref }}
58+
lfs: false
59+
60+
- name: Setup Node.js
61+
uses: actions/setup-node@v5
62+
with:
63+
node-version: "20"
64+
cache: "npm"
65+
66+
- name: Setup Python
67+
uses: actions/setup-python@v6
68+
with:
69+
python-version: "3.12"
70+
cache: "pip"
71+
cache-dependency-path: docs/requirements-mkdocs.txt
72+
73+
- name: Install MkDocs dependencies
74+
run: pip install -r docs/requirements-mkdocs.txt
75+
76+
- name: Install Node dependencies
77+
run: npm ci
78+
79+
- name: Install EdgeOne CLI
80+
run: npm install -g edgeone@1.3.5
81+
82+
- name: Resolve deployment config
83+
id: cfg
84+
shell: bash
85+
run: |
86+
PROJECT_NAME="${{ github.event.inputs.project_name }}"
87+
if [ -z "${PROJECT_NAME}" ]; then
88+
PROJECT_NAME="${{ vars.EDGEONE_PAGES_PROJECT_NAME }}"
89+
fi
90+
if [ -z "${PROJECT_NAME}" ]; then
91+
PROJECT_NAME="${{ secrets.EDGEONE_PAGES_PROJECT_NAME }}"
92+
fi
93+
if [ -z "${PROJECT_NAME}" ]; then
94+
echo "::error::Missing EDGEONE_PAGES_PROJECT_NAME (set workflow input, repository variable, or secret)."
95+
exit 1
96+
fi
97+
DEPLOY_ENV="${{ github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_env || vars.EDGEONE_PAGES_ENV }}"
98+
if [ -z "${DEPLOY_ENV}" ]; then
99+
DEPLOY_ENV="production"
100+
fi
101+
DEPLOY_AREA="${{ github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_area || vars.EDGEONE_PAGES_AREA }}"
102+
if [ -z "${DEPLOY_AREA}" ]; then
103+
DEPLOY_AREA="global"
104+
fi
105+
echo "project_name=${PROJECT_NAME}" >> "$GITHUB_OUTPUT"
106+
echo "deploy_env=${DEPLOY_ENV}" >> "$GITHUB_OUTPUT"
107+
echo "deploy_area=${DEPLOY_AREA}" >> "$GITHUB_OUTPUT"
108+
109+
- name: Validate token secret
110+
env:
111+
EDGEONE_PAGES_API_TOKEN: ${{ secrets.EDGEONE_PAGES_API_TOKEN }}
112+
shell: bash
113+
run: |
114+
if [ -z "${EDGEONE_PAGES_API_TOKEN}" ]; then
115+
echo "::error::Missing EDGEONE_PAGES_API_TOKEN secret."
116+
exit 1
117+
fi
118+
119+
- name: Build and deploy docs to EdgeOne Pages
120+
env:
121+
EDGEONE_PAGES_API_TOKEN: ${{ secrets.EDGEONE_PAGES_API_TOKEN }}
122+
EDGEONE_PAGES_PROJECT_NAME: ${{ steps.cfg.outputs.project_name }}
123+
EDGEONE_PAGES_ENV: ${{ steps.cfg.outputs.deploy_env }}
124+
EDGEONE_PAGES_AREA: ${{ steps.cfg.outputs.deploy_area }}
125+
run: npm run docs:edgeone:publish

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,7 @@ npm-debug.log*
6464
yarn-error.log*
6565
tmp
6666
.npm-cache
67+
68+
# Local docs deploy/build artifacts
69+
.edgeone/
70+
build/mkdocs-site/

‎README.md‎

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 2026-03-24 v1.6.0
1+
# 2026-03-24 v1.6.0
22

33
# NoteConnection Knowledge Graph
44

@@ -326,7 +326,12 @@ For developers building from source, NoteConnection offers two build modes:
326326
- Users: `/diataxis/zh/tutorials/first-run/` or `/diataxis/en/tutorials/first-run/`
327327
- Developers: `/diataxis/en/reference/interfaces-and-runtime/` and `/diataxis/en/reference/release-and-governance/`
328328
- EdgeOne publish command (MkDocs site): `edgeone pages deploy build/mkdocs-site -n noteconnection-docs -e production -a global`.
329+
- One-click docs publish command: `npm run docs:edgeone:publish`.
330+
- CI auto publish workflow (EdgeOne): `.github/workflows/docs-edgeone-publish.yml`.
329331
- CI policy gate for docs mapping and site build: `.github/workflows/docs-diataxis-site.yml`.
332+
- Sharelife community UI docs release + rollback guide:
333+
- English: [`docs/en/sharelife_community_release_and_rollback.md`](docs/en/sharelife_community_release_and_rollback.md)
334+
- 中文: [`docs/zh/sharelife_community_release_and_rollback.md`](docs/zh/sharelife_community_release_and_rollback.md)
330335

331336
## 🛠️ Hardware & Driver Requirements (AMDGPU)
332337

@@ -341,6 +346,16 @@ For optimal performance with "GPU Optimised Rendering", especially on AMD RDNA c
341346

342347
## 📅 Changelog
343348

349+
### v1.6.6 - Unified Provider Runtime & TOML Settings Consolidation (2026-03-26)
350+
- Upgraded NoteMD API calling flow to a definition-driven provider architecture inspired by recent obsidian-NotEMD and cline patterns.
351+
- Added transport-based dispatch (openai-compatible, anthropic, google, azure-openai, ollama) and provider metadata (apiKeyMode, apiTestMode, category).
352+
- Expanded built-in provider presets: Qwen, Doubao, Moonshot, GLM, MiniMax, Groq, Together, Fireworks, Requesty, OpenAI Compatible.
353+
- Unified runtime settings persistence in app_config.toml across Tauri + Godot + NoteMD:
354+
- full NoteMD settings in [notemd] + [[notemd.providers]] (with legacy [notemd.api] compatibility mirror)
355+
- Godot Path Mode settings in [path_mode] with runtime API endpoint /api/path-mode/settings
356+
- Godot settings panel migrated to runtime TOML sync path.
357+
- Hardened Rust-side TOML writes to preserve unknown sections, preventing accidental loss of [notemd] / [path_mode] when Tauri updates KB path or language.
358+
- Updated bilingual documentation and templates for v1.6.6 schema and operations.
344359
### v1.6.5 - Documentation Portal Update (2026-03-26)
345360

346361
- Published MkDocs documentation to EdgeOne Pages project `noteconnection-docs`.
@@ -1217,21 +1232,38 @@ sync_language = true
12171232
- 用户文档：`/diataxis/zh/tutorials/first-run/` 或 `/diataxis/en/tutorials/first-run/`
12181233
- 开发文档：`/diataxis/en/reference/interfaces-and-runtime/` 与 `/diataxis/en/reference/release-and-governance/`
12191234
- EdgeOne 发布命令（MkDocs 产物）：`edgeone pages deploy build/mkdocs-site -n noteconnection-docs -e production -a global`。
1235+
- 一键文档发布命令：`npm run docs:edgeone:publish`。
1236+
- CI 自动发布工作流（EdgeOne）：`.github/workflows/docs-edgeone-publish.yml`。
12201237
- CI 文档治理工作流：`.github/workflows/docs-diataxis-site.yml`。
1238+
- Sharelife 社区界面文档发布与回滚指南：
1239+
- English：[`docs/en/sharelife_community_release_and_rollback.md`](docs/en/sharelife_community_release_and_rollback.md)
1240+
- 中文：[`docs/zh/sharelife_community_release_and_rollback.md`](docs/zh/sharelife_community_release_and_rollback.md)
12211241
12221242
---
12231243
12241244
<a id="changelog-zh"></a>
12251245
12261246
## 更新日志 (Changelog)
12271247
1228-
### v1.6.5 - �ĵ��Ż����£�2026-03-26��
1229-
1230-
- �ѽ� MkDocs �ĵ������� EdgeOne Pages ��Ŀ `noteconnection-docs`��
1231-
- ���� README ������Ӣ�IJ�ѯָ���������û��̳�����뿪���ο���ڣ���
1232-
- ά���߷�������ͳһΪ��
1248+
### v1.6.6 - Provider 运行时流程与 TOML 配置统一 (2026-03-26)
1249+
- 参考 obsidian-NotEMD 与 cline 的 Provider 策略，重构 NoteMD API 调用流为定义驱动。
1250+
- 新增 transport 分发（openai-compatible / anthropic / google / azure-openai / ollama）与 provider 元数据（apiKeyMode、apiTestMode、category）。
1251+
- 扩展内置 Provider 预设：Qwen、Doubao、Moonshot、GLM、MiniMax、Groq、Together、Fireworks、Requesty、OpenAI Compatible。
1252+
- 完成 Tauri + Godot + NoteMD 的 app_config.toml 统一配置：
1253+
- NoteMD 全量配置持久化到 [notemd] + [[notemd.providers]]（保留 [notemd.api] 兼容镜像）
1254+
- Path Mode 配置持久化到 [path_mode]，并提供 /api/path-mode/settings 读写接口
1255+
- Godot 设置面板升级为运行时 TOML 同步链路。
1256+
- 加固 Rust 端 TOML 回写：保留未知 section，避免 Tauri 更新 KB/语言时覆盖 [notemd] / [path_mode]。
1257+
- 同步更新 v1.6.6 双语模板与 Diataxis 文档。
1258+
1259+
### v1.6.5 - 文档门户更新 (2026-03-26)
1260+
1261+
- 已将 MkDocs 文档发布到 EdgeOne Pages 项目 `noteconnection-docs`。
1262+
- 在 README 中补充了面向用户与开发者的中英文文档检索入口。
1263+
- 维护者发布命令统一为：
12331264
- `npm run docs:site:build`
12341265
- `edgeone pages deploy build/mkdocs-site -n noteconnection-docs -e production -a global`
1266+
12351267
### v1.6.0 - 单窗口运行时、NoteMD 集成与发布加固 (2026-03-23)
12361268
12371269
- **Tag 对比快照（`v1.3.0..v1.6.0`）**:

‎docs/diataxis-map.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@
2626
"diataxis": "docs/diataxis/zh/how-to/build-and-export.md"
2727
}
2828
},
29+
{
30+
"id": "publish-docs-edgeone",
31+
"category": "how-to",
32+
"en": {
33+
"canonical": ["docs/en/sharelife_community_release_and_rollback.md", ".github/workflows/docs-edgeone-publish.yml", "scripts/deploy-docs-edgeone.js"],
34+
"diataxis": "docs/diataxis/en/how-to/publish-docs-edgeone.md"
35+
},
36+
"zh": {
37+
"canonical": ["docs/zh/sharelife_community_release_and_rollback.md", ".github/workflows/docs-edgeone-publish.yml", "scripts/deploy-docs-edgeone.js"],
38+
"diataxis": "docs/diataxis/zh/how-to/publish-docs-edgeone.md"
39+
}
40+
},
2941
{
3042
"id": "single-window-runtime",
3143
"category": "how-to",

‎docs/diataxis/en/how-to/publish-docs-edgeone.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# How-To: Publish Docs to EdgeOne and Roll Back
2+
3+
Use this guide to operationalize the docs delivery pipeline:
4+
5+
1. Local one-click deploy
6+
2. GitHub Actions automatic deploy
7+
3. Sharelife community UI release + rollback
8+
9+
## One-click local deploy
10+
11+
```bash
12+
npm run docs:edgeone:publish
13+
```
14+
15+
Quick deploy (skip verify/build):
16+
17+
```bash
18+
npm run docs:edgeone:publish:quick
19+
```
20+
21+
## GitHub Actions deploy
22+
23+
Workflow:
24+
25+
- `.github/workflows/docs-edgeone-publish.yml`
26+
27+
Required secret:
28+
29+
- `EDGEONE_PAGES_API_TOKEN`
30+
31+
Recommended variable/secret:
32+
33+
- `EDGEONE_PAGES_PROJECT_NAME`
34+
35+
Manual rollback deploy:
36+
37+
1. Run workflow `Docs EdgeOne Publish` via `workflow_dispatch`.
38+
2. Set `source_ref` to a stable tag/commit.
39+
3. Deploy to the same target project and environment.
40+
41+
## Sharelife community UI publication and rollback
42+
43+
1. Publish docs first.
44+
2. Update Sharelife community UI "latest docs" entry and version note.
45+
3. Keep previous stable version metadata for immediate rollback.
46+
47+
## Canonical detailed source
48+
49+
- [docs/en/sharelife_community_release_and_rollback.md](../../../en/sharelife_community_release_and_rollback.md)

‎docs/diataxis/en/overview.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This documentation system is organized by Diataxis:
2020
npm run docs:diataxis:check
2121
mkdocs serve --config-file mkdocs.yml
2222
mkdocs build --config-file mkdocs.yml
23+
npm run docs:edgeone:publish
2324
```
2425

2526
## Canonical Source Documents
@@ -29,6 +30,7 @@ mkdocs build --config-file mkdocs.yml
2930
- User manual: [docs/en/User_Manual.md](../../en/User_Manual.md)
3031
- app_config guide: [docs/en/app_config.toml_guide.md](../../en/app_config.toml_guide.md)
3132
- Release compare report: [docs/en/release_v1.6.0_report.md](../../en/release_v1.6.0_report.md)
33+
- Sharelife docs release + rollback: [docs/en/sharelife_community_release_and_rollback.md](../../en/sharelife_community_release_and_rollback.md)
3234

3335
## Runtime Config Entry Points
3436

0 commit comments

Comments
 (0)