Commit Graph
159 Commits
Author SHA1 Message Date
Henry Zhang d06abff597 chore(docs): move docs site to standalone pnoker/iot-dc3-docs repo (#177)
* 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
2026-08-06 14:54:17 +08:00
pnoker e84d2c3ca6 docs(i18n): add Korean, Spanish, Russian README and architecture diagrams
- Add README.ko.md (한국어), README.es.md (Español), README.ru.md (Русский)
- Update language navigation bar in all existing READMEs (en/zh/ja/vi)
- Add architecture panorama SVG and PNG for ko/es/ru (2400x1536 @2x)
- Fix README architecture diagram references to use language-specific images
2026-07-13 14:19:48 +08:00
pnoker 1ea6fb1239 docs(readme): align quickstart docs guidance 2026-07-10 22:26:54 +08:00
pnoker 3a6f99151c docs(readme): move reference architecture details to docs 2026-07-10 22:24:18 +08:00
pnoker bdd9470042 docs(readme): add documentation site link 2026-07-10 22:10:40 +08:00
pnoker 358cfd2f68 docs(readme): streamline readme and docs navigation 2026-07-10 21:23:09 +08:00
pnoker 2b1ae4f536 docs(readme): convert svg to png for gitee rendering and soften ai wording
- convert logo and architecture svg to png (gitee does not render relative-path svg)
- inject per-language fonts (pingfang/hiragino/arial unicode) with white background
- reframe title to multi-protocol, ai-powered, cloud-native across zh/en/ja/vi
- soften 'operate devices directly' to access-controlled ai-assisted operations
- keep original svg for the vitepress docs site
2026-07-10 17:33:37 +08:00
pnoker 501f0a9a71 docs: polish README table formatting and line breaks 2026-06-29 17:53:33 +08:00
pnoker 3439b3d1ee fix(docs): remove .html extensions from README links to match VitePress cleanUrls 2026-06-28 23:47:30 +08:00
pnoker 3c725da38e docs: 新增四层参考架构组件,优化架构图亮色主题与 README 架构概览
- 新增 ArchitectureDiagram.vue 组件,四层架构(应用层/平台层/网络层/感知层)
   高保真还原 architecture-*.svg 布局,Architecture.vue 配色体系
   内联 SVG + CSS 自定义属性,明暗主题自适应
   DICT 字典 zh/en i18n 全覆盖
- architecture-*.svg 四个文件配色从暗色主题转为亮色
- 新增 architecture-panorama-*.svg 产品架构全景图(Architecture.vue 静态版)
- 在架构总览页(zh/en)集成 ArchitectureDiagram 组件
- README(zh/en/ja/vi)架构概览重构:
   新增产品架构全景 + 四层参考架构两张图
   分层表从旧四层(驱动/数据/管理/应用)更新为 IoT 标准四层
   逐层标注 IoT 参考职责 + DC3 落地映射
- 图例标签同步更新:应用/平台/网络/感知/安全/部署
2026-06-28 22:16:56 +08:00
pnoker f301e41c6e style: apply consistent formatting to docs, config, and root files
Line wrapping, table alignment, blank line consistency across config.mts,
i18n, locale JSONs, FAQ, quickstart, frontend/development guides,
superpowers plans, README variants, and PR template.
2026-06-28 19:57:58 +08:00
pnoker c808d45492 refactor: migrate images from dc3/images to docs/public/images
- Rename iot-dc3-architecture-{lang}.svg → architecture-{lang}.svg
- Move all architecture SVGs and screenshots to docs/public/images/
- Update 16 references across all 4 README language variants
- Remove now-empty dc3/images/ directory
2026-06-28 19:57:56 +08:00
pnoker 812e244033 docs: update all README variants with latest logo, archive notices, and localized AI hints
- Replace old logo-blue.png with docs/public/images/logo.svg in all 4 languages
- Note that standalone iot-dc3-web repo is archived, source now in dc3-web/
- Translate AI assistants hint to zh/ja/vi
- Reduce logo width to 240px for better visual balance
2026-06-28 19:57:56 +08:00
pnoker d18bf4d03d style: fix table alignment and whitespace in README files 2026-06-26 13:17:38 +08:00
pnoker 9aa6a425d8 docs(iot-dc3): refresh multilingual README with sharper AI-native positioning and design principles
- Replace slogan with capability-oriented messaging across en/zh/ja/vi
- Add design principles section (Facade, DO/BO/VO, tenant isolation)
- Add contributors badge
- Fix Japanese blockquote rendering breakage
2026-06-23 14:33:07 +08:00
pnoker cba2d54780 docs: align Make command references with new compose shortcuts
Update READMEs, guides, USAGE and the stack-test skill to use the
up-<stack>[-<registry>] targets in place of the removed dev-* commands.
2026-06-18 18:42:28 +08:00
pnoker b674385904 docs: update documentation and README
Refresh architecture, development, operations, and quickstart docs.
Update multi-language README files.
2026-06-11 00:31:34 +08:00
Vickey 69e5fbe0ac docs: restructure documentation and archive engineering notes
Separate the public docs (how to understand, deploy, and use IoT DC3) from
engineering material (design drafts, analyses, roadmaps, legacy operation
screenshots):

- add an internal archive area with its own nav, grouping design,
  analysis, strategy, backlog, and legacy-operation sections
- migrate design, operation (data/device/driver/template), analyses, and
  todo notes into the archive, preserving history
- refresh public docs: README (en/zh/ja/vi), operation guides
  (agentic/concepts/data-commands/device-onboarding), architecture,
  development, guide, quickstart, and modules
- promote the project overview to README.ai.md at the repo root
2026-06-09 18:15:04 +08:00
Vickey dedb03fe74 feat: add command/event attribute configuration system
Introduce CommandAttribute/EventAttribute with config variants:
- REST controllers, MyBatis mappers, services, and DAL managers
- gRPC client/server builders and proto message definitions
- DTOs, BOs, DOs, VOs for type-safe data transfer layer

fix: add explicit ::text casts in json_build_object parameters

PostgreSQL cannot infer parameter types inside json_build_object()
calls. Add ::text casts to #{stateExtType} and #{stateDescription}
to resolve "could not determine data type of parameter $10" errors.

refactor: restructure driver gRPC client and metadata layer

- Rename GrpcStubConfig to DriverClientStubConfig with dedicated DTOs
- Extract attribute builders from inline gRPC conversion logic
- Consolidate driver metadata, register service, and command handling
- Update device state heartbeat and command result event handling

docs: add multilingual architecture diagram and sync READMEs

- Translate architecture SVG into zh, ja, vi variants
- Update README architecture image references per language
- Add missing service-level shortcut sections to ja/vi READMEs
2026-05-25 00:00:00 +08:00
Vickey fd3af64634 feat: add layered architecture diagram and reposition project narrative
- Add IoT DC3 layered architecture diagram (SVG + HTML viewer)
  with Application / Management / Data / Driver layers,
  Security & Load and Platform & System sidebars,
  Data→Driver connection flows, and color-coded sections
- Reposition README descriptions across all languages (en, zh, ja, vi)
  and pom.xml to AI-ready narrative: "Connects devices, collects
  data organized for AI, and orchestrates the closed loop"
- Add README.ai.md with Chinese multi-paragraph AI narrative
  and closed-loop flowchart
- Optimize package.json metadata (name, license, scripts)
2026-05-24 13:35:57 +08:00
pnoker 80ec2beab4 docs: update documentation for compose and Makefile changes
Align all READMEs, AGENTS.md, CONTRIBUTING.md and dc3/doc/* with the
new Makefile interface (SERVICES/GROUP selectors, REGISTRY=cn, podman
default) and updated Dockerfile structure.
2026-05-17 22:16:37 +08:00
pnoker 989443e99f docs(agentic): document provider configuration 2026-05-11 18:58:19 +08:00
pnoker f586f0cd1c docs: align markdown tables and wrap long lines 2026-05-09 23:50:58 +08:00
pnoker 7ba9165195 docs: align governance and environment guides 2026-05-09 20:29:32 +08:00
pnoker 6cf9b43c30 docs(env): align runtime environment variables 2026-05-09 20:14:16 +08:00
pnoker 8fa1f0c152 refactor(container): deduplicate aliyun compose stacks 2026-05-09 18:49:52 +08:00
pnoker a45f2f5ec1 fix(container): include agentic compose service 2026-05-09 18:49:52 +08:00
pnoker 2770eeebca docs: consolidate project documentation under dc3 2026-05-09 18:49:52 +08:00
pnoker e47299a327 chore: remove format and format-check targets from Makefile 2026-05-07 23:55:32 +08:00
pnoker 36d7a82de5 docs: add module overview, quickstart, and troubleshooting guides
- docs/MODULES.md: full module dependency map and runtime flow
- docs/QUICKSTART.md: one-stop local development setup
- docs/TROUBLESHOOTING.md: common build/runtime issues and fixes
- Add docs links to README.md, README.zh.md, README.ja.md, README.vi.md
2026-05-07 13:11:04 +08:00
pnoker c5a9feeeb9 feat: add .env file for Docker Compose configuration and update usage instructions 2026-04-29 10:27:57 +08:00
pnoker ca38651909 feat: add .env file for Docker Compose configuration and update usage instructions 2026-04-21 01:11:59 +08:00
pnoker ea17c86387 chore: update version to 2026.4.19 across all modules and adjust branch settings in codeql.yml 2026-04-19 13:45:21 +08:00
zzi666 518d2a8b7d refactor: update Java docs, README files, and Protobuf comments for consistent language and formatting 2025-10-24 16:51:40 +08:00
Vickey 6bfcfe334e docs: add Japanese and Vietnamese README files and update language switch links 2025-10-05 17:05:26 +08:00
Vickey 68e1fec139 docs: fix blank line formatting in README startup dependencies section 2025-09-13 00:41:26 +08:00
Vickey 5f5278c9f4 docs: add note about exporting database SQL from running container 2025-09-13 00:07:16 +08:00
Vickey d3c9d3f9b6 docs: expand README quickstart sections and add dev env setup script 2025-09-13 00:03:14 +08:00
Vickey 7d369d4408 ci: reorganize workflow step indentation and move doc files to dc3/doc directory 2025-08-30 14:23:04 +08:00
Vickey 2c3e175c26 chore: replace Apache-2.0 license text with AGPL-3.0 and update readme badges 2025-08-26 22:08:03 +08:00
pnoker 7e834f4aa4 docs: update README.md content 2025-08-25 19:07:34 +08:00
Vickey 9ce08cae2f docs: add Chinese README and separate architecture diagrams into en/cn variants 2025-08-24 01:06:07 +08:00
pnoker 298d5a5084 refactor(data): restructure MongoDB configuration and repository service
Restructured MongoDB configuration and repository service to improve maintainability and clarity. Updated dependency management, added new MongoDB-specific classes, and corrected configuration files. This refactor ensures better organization and alignment with the project's architecture.
2025-04-27 21:36:10 +08:00
pnoker a8cd8a1653 docs: update README, copyright year, and replace architecture diagram and logo images 2024-12-29 22:26:19 +08:00
pnoker a282c3878f refactor: move group, label and label-bind builders and services from auth to dal module 2024-12-02 20:28:31 +08:00
zzi666 7bdad7ac9e docs(readme): rewrite README layout and content 2024-07-11 20:38:45 +08:00
pnoker 2c43c14205 docs: trim and rewrite README 2024-05-26 23:12:48 +08:00
zzi666 e7fa93cae2 feat: add device & point metadata update event 2024-05-18 12:29:53 +08:00
pnoker a11caad0f6 refactor: apply broad compatibility fixes across auth, data, manager and drivers 2024-04-30 22:13:13 +08:00
Vickey 503eb27a3e docs: simplify README by removing outdated content 2024-01-04 11:29:33 +08:00