Skip to content

Commit e6b9946

Browse files
committed
doc: user task guide and protocol
- Introduced a new markdown document detailing the DDS user task framework. - Covered key features, environment variables, task communication methods, custom environments, file management, and output management. - Included code examples in C++ and Python for accessing environment variables and utilizing key-value store and custom commands. - Provided best practices and examples for distributed data processing and parameter sweep scenarios.
1 parent 9f2db6b commit e6b9946

File tree

8 files changed

+3679
-85
lines changed

8 files changed

+3679
-85
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,17 @@ DDS is a tool-set that automates and significantly simplifies the deployment of
5555
### Development APIs
5656

5757
* [dds-tools](./dds-tools-lib/README.md) - C++ API for DDS integration
58+
* [dds-intercom](./dds-intercom-lib/README.md) - High-level communication API for custom commands and key-value store
59+
60+
### Agent and Task Development
61+
62+
* [DDS Agent Architecture](./dds-agent/README.md) - Agent internals, lifecycle management, and shared memory transport
63+
* [User Task Development Guide](./docs/user-task-guide.md) - Comprehensive guide for developing DDS tasks with environment variables, communication APIs, custom environments, and file assets
64+
65+
### Protocol Documentation
66+
67+
* [Low-Level Protocol](./docs/protocol-low-level.md) - Binary protocol specification and transport layer
68+
* [High-Level Protocol](./docs/protocol-high-level.md) - Custom commands, key-value store, and Intercom API
5869

5970
### Resource Management Plugins
6071

0 commit comments

Comments
 (0)