文档导航
说明文档的正文统一在本目录维护;根目录保留项目首页,各源码目录只保留简短链接入口。第三方 LICENSE、NOTICE 与字体许可随资源保留,不作为重复说明文档删除。
正文文件名尽量使用中文,MCP、Markdown 等技术名词保留原名。仓库外层 README.md、CONTRIBUTING.md、SECURITY.md 和组件 CHANGELOG.md 保留社区惯例文件名,但除项目首页外均只是链接;GitHub 模板按平台规定保留原名。
| 想了解什么 | 从这里开始 |
|---|---|
| Flutter 入门、需求和架构 | 从零认识维刻 Vex |
| 版本变化 | 更新日志 |
| 开源依赖与贡献者 | 鸣谢 |
| 桌面、手机、平板与安装原型 | 原型设计 |
| 脚本与本机、CI 打包 | 脚本导航、打包与发布 |
| 应用开发与首页媒体 | 应用开发、媒体采集 |
| 编辑器、导图和文档核心 | 编辑器组件、导图组件、Markdown 核心 |
| MCP 使用、工具和联调 | MCP 指南 |
| 字体、品牌、离线原型依赖 | 字体、品牌、离线依赖、安装器语言 |
| 贡献与安全 | 贡献指南、安全政策 |
validation/日期/ 保存各次验收证据,不复制到当前设计说明。media/ 是首页使用的图片和 GIF,assets/ 是学习文档的配图。
应用更新日志与各独立包的版本历史属于不同职责,不合并;它们的正文都在本目录。GitHub Release 说明是某次发行的快照,不再复制一套持续维护的完整更新日志。
内置文档如何进入软件
mermaid
flowchart LR
A[docs 中的更新日志与鸣谢] --> B[sync_builtin_documents.py]
B --> C[Flutter 离线资源]
B --> D[原型离线数据]
C --> E[安装包内只读查看]生成物被 Git 忽略,不手工维护。CI 和完整打包入口先生成再验证;原型预览服务自动刷新。直接打开 HTML 或手动运行 Flutter 前,在仓库根目录运行 python scripts/sync_builtin_documents.py。安装软件后无需 Python、源码目录或联网即可查看这两份文档,也不复制到用户目录。
💬 评论暂未开启
有疑问或建议,欢迎到 GitHub 提交 Issue 参与讨论。
有疑问或建议,欢迎到 GitHub 提交 Issue 参与讨论。