Skip to content

docs: rebuild user guides around released capabilities - #37

Merged
kovawx merged 1 commit into
developfrom
codex/refresh-user-documentation
Sep 30, 2026
Merged

kovawx merged 1 commit into
developfrom
codex/refresh-user-documentation

Conversation

@higanbana986

@higanbana986 higanbana986 commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

变更范围

按用户任务重新组织文档内容和阅读顺序:选择项目 → 安装 → 第一次成功使用 → 日常操作 → 故障排查。开发者入口只保留简洁的项目规范与贡献要求;必要的配置/API 契约保留为按需查阅的参考。

  • 全站:统一 ZBoard「自用与分享的基础面板、按需插件扩展」定位,移除入口中的一站式商业运营描述;下载页明确正式版与候选版,进度页改为版本与使用限制
  • Zero Core:下载优先、完整可复制的本地/远程代理配置、实际操作与故障排查;按已发布 RC 修正 Vision/UDP、VMess、URLTest 和 TUN 边界;WireGuard 单列为公开 dev 实验能力。同步修正 HTTP 响应嵌套、错误状态、探测预算/关联、SSE 过滤及限制、IPC 默认值和分片读取示例
  • ZNet Sink:重写首次连接、订阅、按配置保存的网络设置、DNS/TUN、迁移与诊断;纠正简约模式同时请求系统代理和 TUN、Linux GNOME 集成边界;新增插件安装/授权/更新/卸载指南
  • ZBoard:从部署到首份自用订阅的完整路径,包括零金额分配、显式确认开通和客户端验证;同步实际菜单、仅前置入口授权、外部转发、共享池订阅、已发布插件能力、升级/数据回退限制;缩减重复实现和运维开发叙述
  • 检查器:修复项目选择页被误判为独立项目的问题,增加导航目标/锚点检查;保留已有页面路径与所有旧锚点

共 85 个文件,新增 2 页(Core 贡献入口、Sink 插件使用),正文净篇幅基本不变,重点从实现叙述转向操作说明。没有更改产品代码、依赖、锁文件、CI 或发布配置。

事实来源:对外发布制品

核对日期:2026-09-30。三个产品最近非预发布版本仍为 v0.0.1,下面是主教程采用的已公开候选版;不把 develop 合入等同于已发版。

项目/渠道 已发布版本 固定源码
Core RC(通用指南与接口) v0.0.2-rc.202609290540 2d75265
Core dev(明确标记的实验 WireGuard) v0.0.3-dev.202609281319 e0c078f
ZNet Sink RC v0.0.2-rc.202609291414 3aa5c7f
ZBoard RC v0.0.2-rc.202609291405 cf6f2cf

Core RC 无 WireGuard feature,且不能被描述为已有后来 develop 的 URLTest/严格路由修复。Sink 发布提交与已审读源码的树相同;ZBoard RC 与 main/develop 为同一提交。对应正文也写明版本与限制,详细核对依据在 CONTENT_SYNC.md。

验证结果

  • pnpm check:build:86 个 Markdown 页面,链接、锚点、JSON 示例、项目边界、导航、生产构建与产物完整性通过
  • 独立检查 87 个渲染 HTML 文件、5,662 条本地 href/src,全部可解析
  • 改动页原有 568 个锚点全部保留,36 个新增固定提交的产品源码目标可解析
  • 导航检查器的缺失页面/锚点负例均被拒绝,恢复真实导航后通过
  • 30 个完整/组装后的 Core 配置通过 zero validate;2 个 Python 示例语法解析、2 个 JS 示例语法检查、23 个 ZBoard shell 示例语法检查通过
  • git diff --check
  • Documentation CI #116:准确 head 0c0eec166b14a56a498c2f989643bec03cde90c9 的 validate 已通过,工作流整体 success;release-policy 因目标为 develop 按设计跳过
  • 本地工具:Node 24.19.0 / pnpm 11.19.0;仓库 CI 使用 Node 22 / pnpm 11.9.0
  • 配置校验复用的二进制报告 c71a7c22,不是精确 RC 制品运行验收。运行 smoke 在监听前被 OS 以 Operation not permitted 阻止;没有声称代理转发或 TUN 实机通过
  • 云浏览器访问本地预览被 ERR_BLOCKED_BY_CLIENT 阻止,没有声称视觉验收、桌面安装、真实节点、支付或数据库迁移测试通过

与 #36 的关系

#36 保持独立且未被修改。本 PR 与其侧栏/参考入口有交叉,并在用户指南中解释已发布 RC 的订阅交付和前置授权;不引入它的模块归属长文,也不沿用当时「尚未发布」的描述。若同时接收两者,请先协调导航与重复内容。

目标为 develop 的 draft PR,等待审阅;不合并、不执行正式站点发布或产品部署。

Lead with first-use tasks for Core, ZNet Sink and ZBoard; separate stable,
RC and experimental dev capabilities, trim contributor prose, and correct
public configuration/API contracts against released source.

Validate 86 documentation pages, preserve existing anchors, and strengthen
navigation checks. No product deployment or release promotion.
@kovawx
kovawx marked this pull request as ready for review September 30, 2026 05:31
@kovawx
kovawx merged commit 6d5a175 into develop Sep 30, 2026
2 checks passed
@kovawx
kovawx deleted the codex/refresh-user-documentation branch September 30, 2026 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants