Skip to content

Commit 6f49cf7

Browse files
authored
Merge pull request #4 from VelaShellLabs/docs/move-to-velashell-docs
docs: 文档搬到 velashell-docs,Set-Version 的文档落点改成可选
2 parents b2ce95a + 4b8de6f commit 6f49cf7

10 files changed

Lines changed: 68 additions & 1083 deletions

File tree

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
# Repository owner VelaShellLabs
4040
# Repository velashell-plugin-cli
4141
# Workflow file release.yml
42-
# 建法见 docs/release-process.md 的「NuGet 可信发布」一节。
42+
# 建法见 velashell-docs 的 zh/cli/release-process.md 的「NuGet 可信发布」一节。
4343
#
4444
# 本流水线**不需要任何仓库机密**:程序集不做强名称签名(那只开在 velashell-plugin-sdk
4545
# 那一支 —— 因为宿主要引用它),推送走 OIDC。
@@ -145,7 +145,7 @@ jobs:
145145

146146
# Trusted Publishing:用本次运行的 OIDC 身份换一把短时效推送密钥。
147147
# 换不到密钥基本只有一个原因 —— nuget.org 上那条策略的 Repository / Workflow 字段
148-
# 与本仓库对不上。详见 docs/release-process.md。
148+
# 与本仓库对不上。详见 velashell-docs 的 zh/cli/release-process.md。
149149
- name: NuGet login (trusted publishing)
150150
id: nuget-login
151151
if: ${{ !inputs.dryRun }}

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ vela-plugin update # 以后升级
2020

2121
包来自[插件商店](http://market.easilynet.top),落到 `~/.velashell/plugins/<id>/` ——
2222
与宿主「插件管理页 → 安装 .vpx…」同一个目录。装之前会核对整包摘要、容器摘要、签名与宿主
23-
兼容性;`--source` 可以指到自建商店。完整命令见 [`docs/cli.md`](docs/cli.md)
23+
兼容性;`--source` 可以指到自建商店。完整命令见 [`vela-plugin` 手册](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/cli/cli.md)
2424

2525
写自己的插件:见
26-
[开发指南](https://github.com/VelaShellLabs/velashell-plugin-templates/blob/main/docs/dev-guide.md)
26+
[开发指南](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/templates/dev-guide.md)
2727

2828
## 为什么这两个包在同一个仓库
2929

@@ -54,8 +54,10 @@ velashell-plugin-cli ← 本仓库
5454
velashell-plugin-templates
5555
```
5656

57-
另外两个相关仓库:[joesdu/VelaShell](https://github.com/joesdu/VelaShell)(宿主主程序)、
58-
[VelaShellLabs/velashell-plugins](https://github.com/VelaShellLabs/velashell-plugins)(第一方插件)。
57+
另外三个相关仓库:[joesdu/VelaShell](https://github.com/joesdu/VelaShell)(宿主主程序)、
58+
[VelaShellLabs/velashell-plugins](https://github.com/VelaShellLabs/velashell-plugins)(第一方插件)、
59+
[VelaShellLabs/velashell-docs](https://github.com/VelaShellLabs/velashell-docs)(**全部文档**,
60+
2026-08-30 起各仓库的 `docs/` 都搬到了那里)。
5961

6062
## 两个跨仓库旋钮
6163

@@ -102,11 +104,23 @@ pwsh scripts/Set-Version.ps1 1.5.1 # 落版本号(3 处),连同功能改动
102104
# 再在 GitHub 上发 Release,标签 v1.5.1
103105
```
104106

105-
完整流程见 [`docs/release-process.md`](docs/release-process.md)
107+
完整流程见[发版流程](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/cli/release-process.md)(在文档仓库)。
106108

107109
## 文档
108110

109-
[`docs/cli.md`](docs/cli.md)(中文)· [`docs-en/cli.md`](docs-en/cli.md)(English)。
111+
文档不在本仓库 —— 2026-08-30 起全部集中到
112+
**[VelaShellLabs/velashell-docs](https://github.com/VelaShellLabs/velashell-docs)**。本仓库这份在
113+
[`zh/cli/`](https://github.com/VelaShellLabs/velashell-docs/tree/main/zh/cli)(中文)·
114+
[`en/cli/`](https://github.com/VelaShellLabs/velashell-docs/tree/main/en/cli)(English):
115+
[`vela-plugin` 手册](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/cli/cli.md)[发版流程](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/cli/release-process.md)
116+
117+
隔壁还有:[开发指南](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/templates/dev-guide.md)
118+
[打包发布](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/templates/publishing.md)
119+
[SDK 参考](https://github.com/VelaShellLabs/velashell-docs/blob/main/zh/sdk/sdk-reference.md),
120+
以及插件系统的[架构蓝图](https://github.com/VelaShellLabs/velashell-docs/tree/main/zh/plugins)
121+
122+
> `scripts/Set-Version.ps1` 会顺带把 `zh|en/cli/cli.md` 的版本横幅一起改掉,前提是
123+
> velashell-docs 就 clone 在本仓库同级目录(否则跳过并提醒,见其 `-DocsRoot`)。
110124
111125
## 许可
112126

docs-en/README.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)