mirror of https://gitee.com/pnoker/iot-dc3.git synced 2026-11-02 19:21:51 +08:00

Files

T

pnoker bca6d7aedc docs(site): scaffold MkDocs Material documentation site with GitHub Pages CI

Set up an end-to-end documentation site so contributors and users have
a unified, searchable, and publishable entry point for project docs.

- Add mkdocs.yml: Chinese-first language, light/dark palette, tabbed
  navigation, indexed sections, glightbox for diagrams, and
  pymdownx.snippets so community pages can pull from root governance
  files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md) without
  duplicating content.
- Add requirements-docs.txt pinning mkdocs-material and
  mkdocs-glightbox.
- Build the docs/ skeleton: index, quickstart, guide, architecture,
  development, modules, community. Migrate the seven generic manuals
  from dc3/doc/ (QUICKSTART, ENVIRONMENT, LOGGING, TROUBLESHOOTING,
  MODULES, DRIVER-AUTHORING, TESTING) and rewire their cross-doc
  links. CHANGE.md, TITLE.md, and USAGE.md stay in dc3/doc/ because
  docker-ci.yml depends on them; the docs site references them via
  mkdocs snippets to keep a single source of truth.
- Add .github/workflows/docs.yml that builds with --strict on push to
  release and deploys via actions/deploy-pages.
- Rewrite dc3/doc/README.md as a migration pointer to the new site
  and to the three retained release-flow files.

Verification: mkdocs build --strict passes locally; snippets render
correctly; GitHub Pages already enabled in workflow mode via gh api.

2026-05-18 18:36:00 +08:00

5.5 KiB

Raw Blame History

模块清单

按子项目分类的模块文档索引。每个链接指向 GitHub 上的 README.md 原文件，可在线浏览。

!!! tip "首期范围" 模块文档暂保留在各子模块目录下未做迁移；后续会按需逐步搬入文档站并中文化。

网关 / Gateway

模块	说明	文档
`dc3-gateway`	API 网关，统一入口，HMAC 签名转发	README

中心服务 / Center

模块	说明	文档
`dc3-center-auth`	认证中心，账号/Token/HMAC	README
`dc3-center-manager`	管理中心，设备/驱动/点位/配置治理	README
`dc3-center-data`	数据中心，实时与历史数据	README
`dc3-center-single`	单进程聚合启动（调试用）	README

协议驱动 / Driver

模块	协议	文档
`dc3-driver-virtual`	虚拟驱动（开发模板）	README
`dc3-driver-listening-virtual`	监听式虚拟驱动（TCP/UDP）	README
`dc3-driver-mqtt`	MQTT	README
`dc3-driver-modbus-tcp`	Modbus TCP	README
`dc3-driver-opc-da`	OPC DA	README
`dc3-driver-opc-ua`	OPC UA	README
`dc3-driver-plcs7`	Siemens S7	README

对外 API / API 模块

模块	用途	文档
`dc3-api-auth`	Auth Center 对外 facade	README
`dc3-api-manager`	Manager Center 对外 facade	README
`dc3-api-data`	Data Center 对外 facade	README
`dc3-api-driver`	Driver 对外 facade	README

公共组件 / Common

模块	用途	文档
`dc3-common-api`	跨服务 API 协议定义	README
`dc3-common-auth`	认证、HMAC、租户上下文	README
`dc3-common-constant`	常量与枚举	README
`dc3-common-dal`	数据访问层基础	README
`dc3-common-data`	数据领域模型	README
`dc3-common-driver`	驱动 SDK	README
`dc3-common-exception`	异常类型	README
`dc3-common-gateway`	网关共用	README
`dc3-common-log`	日志规范	README
`dc3-common-manager`	管理领域模型	README
`dc3-common-model`	通用模型	README
`dc3-common-mqtt`	MQTT 客户端封装	README
`dc3-common-postgres`	Postgres 数据源	README
`dc3-common-public`	公开工具类	README
`dc3-common-quartz`	定时任务	README
`dc3-common-rabbitmq`	RabbitMQ 客户端	README
`dc3-common-repository`	Repository 抽象	README
`dc3-common-thread`	线程池	README
`dc3-common-web`	Web 通用	README

5.5 KiB Raw Blame History Unescape Escape