This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fory-site.git
The following commit(s) were added to refs/heads/main by this push:
new d47876b275 🔄 synced local 'docs/guide/' with remote 'docs/guide/'
d47876b275 is described below
commit d47876b275c8667f11914ae028a61ade677ba839
Author: chaokunyang <[email protected]>
AuthorDate: Fri Jun 12 20:55:42 2026 +0000
🔄 synced local 'docs/guide/' with remote 'docs/guide/'
---
docs/guide/rust/index.md | 15 ++++++++++-----
docs/guide/rust/troubleshooting.md | 2 +-
2 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/docs/guide/rust/index.md b/docs/guide/rust/index.md
index c2212a1f7b..67de0b3bb0 100644
--- a/docs/guide/rust/index.md
+++ b/docs/guide/rust/index.md
@@ -36,11 +36,16 @@ The Rust implementation provides versatile and
high-performance serialization wi
## Crates
-| Crate
| Description | Version
|
-| ---------------------------------------------------------------------------
| --------------------------------- |
--------------------------------------------- |
-| [`fory`](https://github.com/apache/fory/blob/main/rust/fory)
| High-level API with derive macros | [1.1.0](https://crates.io/crates/fory)
|
-| [`fory-core`](https://github.com/apache/fory/blob/main/rust/fory-core/)
| Core serialization engine |
[1.1.0](https://crates.io/crates/fory-core) |
-| [`fory-derive`](https://github.com/apache/fory/blob/main/rust/fory-derive/)
| Procedural macros |
[1.1.0](https://crates.io/crates/fory-derive) |
+| Crate
| Description | Version
|
+| ---------------------------------------------------------------------------
| --------------------------------------------------------- |
--------------------------------------------- |
+| [`fory`](https://github.com/apache/fory/blob/main/rust/fory)
| User-facing API, runtime types, and derive macros |
[1.1.0](https://crates.io/crates/fory) |
+| [`fory-core`](https://github.com/apache/fory/blob/main/rust/fory-core/)
| Lower-level runtime crate for advanced integrations |
[1.1.0](https://crates.io/crates/fory-core) |
+| [`fory-derive`](https://github.com/apache/fory/blob/main/rust/fory-derive/)
| Lower-level procedural macro crate for direct runtime use |
[1.1.0](https://crates.io/crates/fory-derive) |
+
+Most applications should depend on `fory` only. It re-exports the derive
+macros and the public runtime types needed by generated code. Use `fory-core`
+or `fory-derive` directly only when intentionally building on the lower-level
+runtime crates.
## Quick Start
diff --git a/docs/guide/rust/troubleshooting.md
b/docs/guide/rust/troubleshooting.md
index 285c99a8da..6f25c1f927 100644
--- a/docs/guide/rust/troubleshooting.md
+++ b/docs/guide/rust/troubleshooting.md
@@ -144,7 +144,7 @@ cargo test --features tests
## Error Handling Best Practices
-Prefer the static constructors on `fory_core::error::Error`:
+Prefer the static constructors on the facade `Error` type:
- `Error::type_mismatch`
- `Error::invalid_data`
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
