initial mdbook docs structure

Author: rex-schilasky

rustecal/docs/src/SUMMARY.md

@@ -1,6 +1,14 @@
 # Summary
 
 - [Introduction](introduction.md)
-- [Usage Guide](usage.md)
-- [Message Types](types.md)
-- [Architecture Overview](architecture.md)
+- [Getting Started](setup/prerequisites.md)
+  - [Install eCAL](setup/ecal_installation.md)
+- [Project Structure](project_structure.md)
+- [Message Types](types/message_types.md)
+- [Examples](examples/index.md)
+  - [Binary](examples/binary.md)
+  - [String](examples/string.md)
+  - [Protobuf](examples/protobuf.md)
+- [API Documentation](api/index.md)
+- [Project Status](project_status.md)
+- [About](about.md)

rustecal/docs/src/about.md

@@ -0,0 +1,8 @@
+# About
+
+Created by Rex Schilasky  
+🚗 Automotive | 🧠 SDV | 🛠️ Rust | 🚀 IPC
+
+## License
+
+Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)

rustecal/docs/src/architecture.md

@@ -0,0 +1,38 @@
+# Binary Message Example
+
+## Publisher
+
+```rust
+use rustecal::{Ecal, EcalComponents, TypedPublisher};
+use rustecal_types_bytes::BytesMessage;
+
+fn main() {
+    Ecal::initialize(Some("blob publisher"), EcalComponents::DEFAULT).unwrap();
+    let pub_ = TypedPublisher::<BytesMessage>::new("blob").unwrap();
+    let mut counter = 0u8;
+    loop {
+        let buf = vec![counter; 1024];
+        pub_.send(&BytesMessage(buf));
+        counter = counter.wrapping_add(1);
+        std::thread::sleep(std::time::Duration::from_millis(500));
+    }
+}
+```
+
+## Subscriber
+
+```rust
+use rustecal::{Ecal, EcalComponents, TypedSubscriber};
+use rustecal_types_bytes::BytesMessage;
+
+fn main() {
+    Ecal::initialize(Some("blob subscriber"), EcalComponents::DEFAULT).unwrap();
+    let mut sub = TypedSubscriber::<BytesMessage>::new("blob").unwrap();
+    sub.set_callback(|msg| {
+        println!("Received blob of {} bytes", msg.msg.0.len());
+    });
+    while Ecal::ok() {
+        std::thread::sleep(std::time::Duration::from_millis(500));
+    }
+}
+```

rustecal/docs/src/examples/binary.md

@@ -0,0 +1,3 @@
+# Examples
+
+Code samples for using rustecal.

rustecal/docs/src/examples/index.md

@@ -0,0 +1,40 @@
+# Protobuf Message Example
+
+## Publisher
+
+```rust
+use rustecal::{Ecal, EcalComponents, TypedPublisher};
+use rustecal_types_protobuf::{ProtobufMessage, IsProtobufType};
+mod person { include!(concat!(env!("OUT_DIR"), "/pb.people.rs")); }
+use person::Person;
+
+impl IsProtobufType for Person {}
+
+fn main() {
+    Ecal::initialize(Some("protobuf publisher"), EcalComponents::DEFAULT).unwrap();
+    let pub_ = TypedPublisher::<ProtobufMessage<Person>>::new("person").unwrap();
+    loop {
+        let person = Person { id: 1, name: "Alice".into(), ..Default::default() };
+        pub_.send(&ProtobufMessage(person));
+        std::thread::sleep(std::time::Duration::from_millis(500));
+    }
+}
+```
+
+## Subscriber
+
+```rust
+use rustecal::{Ecal, EcalComponents, TypedSubscriber};
+use rustecal_types_protobuf::ProtobufMessage;
+mod person { include!(concat!(env!("OUT_DIR"), "/pb.people.rs")); }
+use person::Person;
+
+fn main() {
+    Ecal::initialize(Some("protobuf subscriber"), EcalComponents::DEFAULT).unwrap();
+    let mut sub = TypedSubscriber::<ProtobufMessage<Person>>::new("person").unwrap();
+    sub.set_callback(|msg| println!("Received person: {}", msg.msg.0.name));
+    while Ecal::ok() {
+        std::thread::sleep(std::time::Duration::from_millis(500));
+    }
+}
+```

rustecal/docs/src/examples/protobuf.md

@@ -0,0 +1,34 @@
+# String Message Example
+
+## Publisher
+
+```rust
+use rustecal::{Ecal, EcalComponents, TypedPublisher};
+use rustecal_types_string::StringMessage;
+
+fn main() {
+    Ecal::initialize(Some("string publisher"), EcalComponents::DEFAULT).unwrap();
+    let publisher = TypedPublisher::<StringMessage>::new("hello").unwrap();
+    loop {
+        let msg = StringMessage(format!("Hello from Rust"));
+        publisher.send(&msg);
+        std::thread::sleep(std::time::Duration::from_millis(500));
+    }
+}
+```
+
+## Subscriber
+
+```rust
+use rustecal::{Ecal, EcalComponents, TypedSubscriber};
+use rustecal_types_string::StringMessage;
+
+fn main() {
+    Ecal::initialize(Some("string subscriber"), EcalComponents::DEFAULT).unwrap();
+    let mut sub = TypedSubscriber::<StringMessage>::new("hello").unwrap();
+    sub.set_callback(|msg| println!("Received: {}", msg.msg.0));
+    while Ecal::ok() {
+        std::thread::sleep(std::time::Duration::from_millis(500));
+    }
+}
+```

rustecal/docs/src/examples/string.md

@@ -1,13 +1,3 @@
 # Introduction
 
-Welcome to **rustecal**, a safe and idiomatic Rust binding for [Eclipse eCAL](https://github.com/eclipse-ecal/ecal).
-
-This project is designed to bring fast and reliable pub-sub and service-based IPC to Rust-based applications in domains such as robotics, automotive, embedded, and distributed systems.
-
-rustecal wraps the low-level `ecal_c` C API and builds ergonomic, type-safe abstractions for working with:
-
-- Publishers and Subscribers
-- Strongly typed message serialization (e.g., Strings, Bytes, Protobuf)
-- Cross-platform interprocess communication
-
-This documentation will guide you through usage, architecture, and message type support.
+`rustecal` is a safe and idiomatic Rust wrapper for [Eclipse eCAL](https://github.com/eclipse-ecal/ecal), designed for high-performance interprocess communication (IPC) in robotics, automotive, and embedded systems.

rustecal/docs/src/introduction.md

@@ -0,0 +1,10 @@
+# Roadmap
+
+- [x] Cross-platform support (Windows, Linux)
+- [x] Safe API for initialization, shutdown, and pub/sub
+- [x] Typed pub/sub APIs
+- [x] Modular type crates (string, bytes, protobuf)
+- [x] Examples for all supported types
+- [ ] Protobuf descriptor introspection
+- [ ] eCAL Services (RPC-style)
+- [ ] Monitoring and logging support

rustecal/docs/src/project_status.md

@@ -0,0 +1,29 @@
+# Project Structure
+
+| Crate | Description |
+|-------|-------------|
+| `rustecal-sys` | Low-level unsafe bindings (via `bindgen`) |
+| `rustecal` | Safe and idiomatic high-level wrapper |
+| `rustecal-types-bytes` | Support for raw byte messages |
+| `rustecal-types-string` | UTF-8 string message support |
+| `rustecal-types-protobuf` | Protobuf support using `prost` |
+| `rustecal-samples` | Working binary examples |
+
+## Workspace Layout
+
+```
+your_workspace/
+├── rustecal/
+├── rustecal-sys/
+├── rustecal-types-bytes/
+├── rustecal-types-string/
+├── rustecal-types-protobuf/
+└── rustecal-samples/
+    └── pubsub/
+        ├── blob_send/
+        ├── blob_receive/
+        ├── hello_send/
+        ├── hello_receive/
+        ├── person_send/
+        └── person_receive/
+```