完整的文档索引,快速找到您需要的信息
适合第一次接触本课程的学习者,快速了解课程并开始学习。
| 文档 | 说明 | 适合人群 | 阅读时间 |
|---|---|---|---|
| 快速入门 | 5分钟快速上手指南 | 🌟 所有用户 | 5分钟 |
| 环境配置 | 详细的环境安装和配置 | 首次安装 | 10分钟 |
快速链接:
适合深入学习的学习者,包含完整的学习路径和技术细节。
| 文档 | 说明 | 适用场景 |
|---|---|---|
| 课程学习指南 | 完整的学习指南,包含12课时详解 | 深入学习者 |
| 课程初始化说明 | 课程自动初始化和库导入详解 | 所有用户 |
| CNB部署指南 | CNB云原生部署完整指南 | 部署人员 |
| 环境配置指南 | 环境安装和配置详细说明 | 首次安装 |
适合技术开发者或维护者,了解项目的技术细节。
| 文档 | 说明 | 适用人群 |
|---|---|---|
| 脚本改进说明 | 启动脚本优化历史 | 开发者 |
了解项目的版本历史和功能更新。
| 文档 | 说明 |
|---|---|
| CHANGELOG | 完整的版本更新历史 |
| v1.1.0-自动环境配置 | 本次自动环境配置功能详细说明 |
推荐阅读顺序:
关键链接:
推荐阅读顺序:
关键链接:
推荐阅读顺序:
关键链接:
| 命令 | 说明 |
|---|---|
./scripts/auto_setup_env.sh | 自动环境配置 |
./scripts/start.sh | 本地启动 |
./scripts/start_docker.sh | Docker启动 |
./scripts/cnb_deploy.sh | CNB部署 |
python ../utils/course_utils.py | 导入课程工具模块 |
python ../utils/test_environment.py | 测试环境 |
| 类型 | 路径 |
|---|---|
| 课程文件 | lessons/lesson*.ipynb |
| 工具模块 | utils/*.py |
| 启动脚本 | scripts/*.sh |
| 文档 | docs/**/*.md |
| 部署配置 | deployment/ |
查看文档
运行诊断
python utils/test_environment.py
搜索错误信息
查看技术文档
docs/ ├── README.md # 本文档 - 文档索引 ├── getting-started/ # 快速开始 │ ├── 快速入门.md # 5分钟快速上手 │ └── 环境配置.md # 环境配置详细指南 ├── guides/ # 详细指南 │ ├── 课程学习指南.md # 完整学习指南 │ ├── 课程初始化说明.md # 课程初始化详解 │ └── CNB部署指南.md # CNB部署指南 ├── technical/ # 技术文档 │ └── 脚本改进说明.md # 脚本优化历史 └── changelog/ # 更新日志 ├── CHANGELOG.md # 版本更新历史 └── v1.1.0-自动环境配置.md # 详细更新说明
如果您想改进文档:
如有问题或建议,请通过以下方式联系:
文档最后更新: 2026-02-06