Skip to content

Commit

Permalink
Merge pull request #342 from cunarist/organize-docs-sections
Browse files Browse the repository at this point in the history
Organize docs section names
  • Loading branch information
temeddix authored Jun 1, 2024
2 parents 6436c47 + 65be6d1 commit 20e1013
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions documentation/docs/detailed-techniques.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Detailed Techniques

## 🏷️ Signal Details
## 🏷️ Signal Members

We've covered how to pass signals[^1] between Dart and Rust in the previous tutorial section. Now Let's delve into the meaning of each field of a signal.

Expand All @@ -13,25 +13,23 @@ It's important to note that creating a Protobuf `message` larger than a few mega
[^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.
[^2]: Sending a serialized message or binary data is a zero-copy operation from Rust to Dart, while it involves a copy operation from Dart to Rust in memory. Keep in mind that Protobuf's serialization and deserialization does involve memory copy.

## 📦 Message Details

### Generated Path
## 🗃️ Generation Path

When you generate message code using the `rinf message` command, the resulting Dart and Rust modules' names and subpaths will precisely correspond to those of the `.proto` files.

- `./messages` : The `.proto` files under here and its subdirectories will be used.
- `./lib/messages` : The generated Dart code will be placed here.
- `./native/hub/src/messages` : The generated Rust code will be placed here.

### Continuous Watching
## 🕶️ Continuous Watching

If you add the optional argument `-w` or `--watch` to the `rinf message` command, the message code will be automatically generated when `.proto` files are modified. If you add this argument, the command will not exit on its own.

```bash title="CLI"
rinf message --watch
```

### Comments
## 💬 Comments

It is possible to add comments like this.[^3]

Expand Down

0 comments on commit 20e1013

Please sign in to comment.