Repository navigation
docs: rebuild user guides around released capabilities - #37
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
变更范围
按用户任务重新组织文档内容和阅读顺序:选择项目 → 安装 → 第一次成功使用 → 日常操作 → 故障排查。开发者入口只保留简洁的项目规范与贡献要求;必要的配置/API 契约保留为按需查阅的参考。
共 85 个文件,新增 2 页(Core 贡献入口、Sink 插件使用),正文净篇幅基本不变,重点从实现叙述转向操作说明。没有更改产品代码、依赖、锁文件、CI 或发布配置。
事实来源:对外发布制品
核对日期:2026-09-30。三个产品最近非预发布版本仍为 v0.0.1,下面是主教程采用的已公开候选版;不把 develop 合入等同于已发版。
Core RC 无 WireGuard feature,且不能被描述为已有后来 develop 的 URLTest/严格路由修复。Sink 发布提交与已审读源码的树相同;ZBoard RC 与 main/develop 为同一提交。对应正文也写明版本与限制,详细核对依据在 CONTENT_SYNC.md。
验证结果
0c0eec166b14a56a498c2f989643bec03cde90c9的 validate 已通过,工作流整体 success;release-policy 因目标为 develop 按设计跳过与 #36 的关系
#36 保持独立且未被修改。本 PR 与其侧栏/参考入口有交叉,并在用户指南中解释已发布 RC 的订阅交付和前置授权;不引入它的模块归属长文,也不沿用当时「尚未发布」的描述。若同时接收两者,请先协调导航与重复内容。
目标为 develop 的 draft PR,等待审阅;不合并、不执行正式站点发布或产品部署。