mirror of
https://gitee.com/pnoker/iot-dc3.git
synced 2026-11-01 18:51:53 +08:00
Henry Zhang
d06abff597
* chore(docs): move docs site to standalone pnoker/iot-dc3-docs repo The VitePress docs site now lives in pnoker/iot-dc3-docs and serves docs.dc3.site from there. Remove the in-repo docs/ and all docs-only build/deploy wiring so nothing dangles. - delete docs/ (source moved to pnoker/iot-dc3-docs) - delete .github/workflows/docs.yml (deploy owned by iot-dc3-docs) - drop npm /docs dependabot block; clean codeql/.gitignore docs paths - remove Makefile docs-* targets - relocate AI testing policy into dc3-web/tests/ so the required Web guardrail test is self-contained (was reading ../docs/...) - rewire README image refs (7 READMEs) and in-repo doc links (README.ai.md, AGENTS.md, dc3/doc/README.md) to https://docs.dc3.site / the new repo dc3/doc/{TITLE,CHANGE,USAGE}.md STAY - release tooling (make changelog, docker-ci) regenerates them; the docs repo snapshots them. * fix(docs): repair pre-existing broken doc links found during migration - 8 READMEs: /en|zh/introduction/technology-stack -> /en|zh/development/technology-stack (page lives under development/, not introduction/) - dc3-web/tests/README.md: ../docs/test-debugging.md (missing) -> https://docs.dc3.site/en/frontend/test-debugging
2.2 KiB
2.2 KiB
IoT DC3 Documentation
大部分文档已迁移到项目文档站。本目录仅保留 release 流程依赖的源文件。
在线文档
- 在线文档：https://docs.dc3.site/
- 文档站源文件仓库：pnoker/iot-dc3-docs
仍保留在本目录的文件（被 CI 直接引用，请勿迁移）
| 文件 | 用途 |
|---|---|
TITLE.md |
release 标题与简介，由 .github/workflows/docker-ci.yml 拼入 GitHub Release body |
CHANGE.md |
版本变更日志，由 dc3/bin/changelog.py 写入，docker-ci 拼入 release body |
USAGE.md |
镜像使用说明，docker-ci 拼入 release body |
文档站里的 变更日志 与 镜像与部署 通过 VitePress 的
<!--@include:--> 语法直接引用上述源文件，保持单一信源。
已迁移到文档站的旧路径对照
| 旧路径 | 新位置 |
|---|---|
dc3/doc/QUICKSTART.md |
快速开始 |
dc3/doc/ENVIRONMENT.md |
环境变量 |
dc3/doc/LOGGING.md |
日志规范 |
dc3/doc/TROUBLESHOOTING.md |
故障排查 |
dc3/doc/MODULES.md |
模块与依赖 |
dc3/doc/DRIVER-AUTHORING.md |
驱动开发 |
dc3/doc/TESTING.md |
测试 |
如果你是从外部链接跳转到此页面，请更新书签到对应的新地址。