mirror of https://gitee.com/pnoker/iot-dc3.git synced 2026-11-03 11:42:04 +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

1.1 KiB

Raw Blame History

开发

参与 IoT DC3 二次开发与协议扩展的入口。

:material-tools: 驱动开发

基于 dc3-driver-virtual 模板从零搭建新协议驱动
:material-test-tube: 测试

单元测试 / 集成测试约定、Mock 策略、覆盖率门槛
:material-history: 变更日志

版本演进与重要变更记录

开发约定速览

JDK 21、Maven 3.9+：版本由 Maven Enforcer 强制
Spring Java Format：提交前由 spotless 校验，CI 也会拦截不合规格式
分支模型：从 main 切 feature/<author>/<topic>，PR 合入 develop，发布走 release
AI 协作：仓库根目录 AGENTS.md 定义了 AI 助手协作规约（指令优先级、提交身份、变更日志规则）

1.1 KiB Raw Blame History Unescape Escape

开发

开发约定速览

相关入口

1.1 KiB

Raw Blame History