[Quality] 文档完整性: Missing files referenced in documentation

[newtontech]

实际问题

Issue 1: Missing CONTRIBUTING.md (文件不存在但被引用)

文件:
代码:

问题: README 引用了 ，但该文件在仓库中不存在。这是一个断链。

---

Issue 2: 缺失的源代码目录

文件:
代码:

问题: 主入口点引用 ，但整个 目录不存在。

---

Issue 3: Deploy Workflow 引用不存在的构建脚本

文件:
代码:
No build script
问题: 回退的 在 中未定义。工作流假设 存在构建产物，但没有可构建的代码。

---

Issue 4: Screenshots 占位符

文件:
代码:

问题: 自项目初始化以来，screenshots 部分一直是占位符。

---

Issue 5: 缺少 API/代码文档

问题: 尽管依赖 Three.js、React 和 Electron，但没有：

• API 文档
• 架构文档
• 代码示例
• 开发者指南

---

改进建议

1. 创建 CONTRIBUTING.md:
   git clone https://github.com/YOUR_USERNAME/molviz.gitnpm installgit checkout -b feature/your-featurenpm test

2. 创建基本的 src/ 结构 或更新文档以反映项目当前状态:

3. 修复 deploy.yml:

4. 添加 CHANGELOG.md:

为什么重要

问题	影响
缺失 CONTRIBUTING.md	贡献者无法找到贡献指南，降低社区参与度
缺失 src/ 目录	项目无法按文档说明构建和运行
损坏的 CI/CD	部署流程失败，无可用产物
占位符文档	降低项目可信度，用户无法预览功能
缺失 API 文档	新开发者无法理解和贡献代码

优先级

• 高 - 缺失 CONTRIBUTING.md 和 src/ 目录影响基础可用性
• 中 - Deploy workflow 和 API 文档
• 低 - Screenshots 和 CHANGELOG