词遇同时在 GitHub 和 Gitee 开源,两个平台地位相同。此仓库保存组织介绍与共用的贡献、安全和支持入口。profile/README.md 用于 GitHub 组织首页;Gitee 可直接阅读对应仓库文档,不假定平台使用同样的首页规则。产品运行代码和协议规范由各自仓库维护。
| 入口 | 解决什么问题 |
|---|---|
| 组织首页 | 词遇做什么、三种使用方式、项目分工及版本边界 |
| 中文文档源码 | 产品 → 使用 → 功能 / 架构 → 开发路径 |
| 贡献指南 | 问题归属、复现材料、代码 / 文档提交和验证 |
| 安全说明 | 漏洞和用户资料如何安全报告 |
| 支持说明 | 使用、环境、连接与资料问题如何定位 |
| 行为准则 | 尊重、隐私和社区交流 |
| 更新日志 | 组织入口有哪些结果性更新 |
新用户可以先选择 Desktop、Browser 独立模式或 Browser 连接模式。开发者按职责找到对应仓库后,再阅读该仓的 docs:桌面系统能力 → Desktop;事务与学习判定 → Core;网页与独立工作区 → Browser;共同连接边界 → LMCP;公共资源 → Dictionary。
- 本地优先:1.0.0 没有云端账号或同步;2.0.0 才规划独立设备同步。
- 一个写入者:Desktop Core 保存桌面资料;连接插件只读取词卡和提交采集,桌面学习状态由 Core 计算。
- 资料归属明确:连接时封存独立资料 A,使用桌面资料 B+C;明确断开后恢复 A,临时失联时不能静默写回 A。
- 证据与交付分开:分别记录源码单元测试、真实客户端测试、实际包测试和各平台人工验收;工作流配置不能证明产品已发布或已在线上验证。
- 公共资源只读:词包安装不重建个人学习库;身份、规则与版本不能仅靠词头猜测。
设计解释放在官方文档源码,完整实现与正式接口留在所属仓库。组织首页提供阅读入口,不另存一份容易与原仓库不一致的全量 API、表结构或测试计数。
修改首页时同时核对真实项目 README 和当前路线,检查 Markdown 相对链接与远端仓库目标。不得加入尚未发布的下载 / 商店 / 云服务承诺、虚构维护者或联系邮箱,不上传私有资料和过程日志。完成后更新 CHANGELOG 与中文提交说明;推送和发布由维护者明确授权。
本仓随 1.0.0 软件版本更新文档,不单独打产品版本标签。已公开的 main 保留原始 init commit 与整理后的结果提交;之后正常追加提交,不因增加平台重写历史。开发历史备份不进入公开分支。提交前运行 npm ci --ignore-scripts && npm run verify;main、PR 与手动工作流检查链接、图表原字节和格式。步骤与后续版本原则见维护与发布。
自有文档采用 AGPL-3.0-only。该许可只覆盖词遇自有内容;第三方依赖、词典来源、音频和引用资料保留原许可,不能用组织许可替换来源要求。见文档站许可说明。