diff --git a/documentation/docs/detailed-techniques.md b/documentation/docs/detailed-techniques.md index 08abd19c..2982881c 100644 --- a/documentation/docs/detailed-techniques.md +++ b/documentation/docs/detailed-techniques.md @@ -8,7 +8,7 @@ We've covered how to pass signals[^1] between Dart and Rust in the previous tuto - **Field `binary`:** This is a field designed to handle large binary data, potentially up to a few gigabytes. You can send any kind of binary data you wish, such as a high-resolution image or file data. This field carries empty `Uint8List` or `Vec` if the message is not marked as binary signal. -It's important to note that creating a Protobuf `message` larger than a few megabytes is not recommended. For large data, split them into multiple signals, or use the `binary` field.[^2] +It's important to note that creating a Protobuf `message` larger than a few megabytes is not recommended. For large data, split them into multiple signals, or use the `binary` field instead.[^2] [^1]: Rinf relies solely on native FFI for communication, avoiding the use of web protocols or hidden threads. The goal is to minimize performance overhead as much as possible. diff --git a/documentation/docs/error-handling.md b/documentation/docs/error-handling.md index 51285fea..1cd58462 100644 --- a/documentation/docs/error-handling.md +++ b/documentation/docs/error-handling.md @@ -2,11 +2,11 @@ Effective error handling is crucial in applications to ensure a smooth user experience and predictable application behavior. -Rinf expects developers to use Flutter exclusively for the UI layer while keeping all business logic in Rust. This approach encourages handling errors and logging directly in Rust without crossing the language boundary. +Rinf expects developers to use Flutter exclusively for the UI layer while keeping all business logic in Rust. This approach encourages handling errors and logging directly in Rust without crossing the language boundary.[^1] -Rinf doesn't automatically handle Rust errors for you. By explicitly managing these errors, you can make your app clearer and more robust. Rinf was designed to be a reliable framework without excessive abstractions or implicit behaviors. +[^1]: Rinf doesn't automatically handle Rust errors for you. By explicitly managing these errors, you can make your app clearer and more robust. Rinf was designed to be a reliable framework without excessive abstractions or implicit behaviors. -However, there are recommended practices for managing errors in real-world applications. +There are recommended practices for managing errors in real-world applications. ## 🌪️ No Panicking