Skip to content

Commit 621ee53

Browse files
authored
docs(java): update graalvm guide location (#3588)
## Why? ## What does this PR do? ## Related issues ## AI Contribution Checklist - [ ] Substantial AI assistance was used in this PR: `yes` / `no` - [ ] If `yes`, I included a completed [AI Contribution Checklist](https://github.com/apache/fory/blob/main/AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs) in this PR description and the required `AI Usage Disclosure`. - [ ] If `yes`, my PR description includes the required `ai_review` summary and screenshot evidence of the final clean AI review results from both fresh reviewers on the current PR diff or current HEAD after the latest code changes. ## Does this PR introduce any user-facing change? - [ ] Does this PR introduce any public API change? - [ ] Does this PR introduce any binary protocol compatibility change? ## Benchmark
1 parent b40a2ec commit 621ee53

14 files changed

Lines changed: 404 additions & 23 deletions

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -576,16 +576,16 @@ For more details on row format, see [Row Format Specification](docs/specificatio
576576

577577
### User Guides
578578

579-
| Guide | Description | Source | Website |
580-
| -------------------------------- | ------------------------------------------ | ----------------------------------------------- | ------------------------------------------------------------------- |
581-
| **Java Serialization** | Comprehensive guide for Java serialization | [java](docs/guide/java) | [📖 View](https://fory.apache.org/docs/guide/java/) |
582-
| **Python** | Python-specific features and usage | [python](docs/guide/python) | [📖 View](https://fory.apache.org/docs/guide/python/) |
583-
| **Rust** | Rust implementation and patterns | [rust](docs/guide/rust) | [📖 View](https://fory.apache.org/docs/guide/rust/) |
584-
| **C++** | C++ implementation and patterns | [cpp](docs/guide/cpp) | [📖 View](https://fory.apache.org/docs/guide/cpp/) |
585-
| **Scala** | Scala integration and best practices | [scala](docs/guide/scala) | [📖 View](https://fory.apache.org/docs/guide/scala/) |
586-
| **Cross-Language Serialization** | Multi-language object exchange | [xlang](docs/guide/xlang) | [📖 View](https://fory.apache.org/docs/guide/xlang/) |
587-
| **GraalVM** | Native image support and AOT compilation | [graalvm_guide.md](docs/guide/graalvm_guide.md) | [📖 View](https://fory.apache.org/docs/guide/graalvm_serialization) |
588-
| **Development** | Building and contributing to Fory | [DEVELOPMENT.md](docs/guide/DEVELOPMENT.md) | [📖 View](https://fory.apache.org/docs/guide/development) |
579+
| Guide | Description | Source | Website |
580+
| -------------------------------- | ------------------------------------------ | -------------------------------------------------------- | ------------------------------------------------------------------ |
581+
| **Java Serialization** | Comprehensive guide for Java serialization | [java](docs/guide/java) | [📖 View](https://fory.apache.org/docs/guide/java/) |
582+
| **Python** | Python-specific features and usage | [python](docs/guide/python) | [📖 View](https://fory.apache.org/docs/guide/python/) |
583+
| **Rust** | Rust implementation and patterns | [rust](docs/guide/rust) | [📖 View](https://fory.apache.org/docs/guide/rust/) |
584+
| **C++** | C++ implementation and patterns | [cpp](docs/guide/cpp) | [📖 View](https://fory.apache.org/docs/guide/cpp/) |
585+
| **Scala** | Scala integration and best practices | [scala](docs/guide/scala) | [📖 View](https://fory.apache.org/docs/guide/scala/) |
586+
| **Cross-Language Serialization** | Multi-language object exchange | [xlang](docs/guide/xlang) | [📖 View](https://fory.apache.org/docs/guide/xlang/) |
587+
| **GraalVM** | Native image support and AOT compilation | [graalvm_support.md](docs/guide/java/graalvm_support.md) | [📖 View](https://fory.apache.org/docs/guide/java/graalvm_support) |
588+
| **Development** | Building and contributing to Fory | [DEVELOPMENT.md](docs/guide/DEVELOPMENT.md) | [📖 View](https://fory.apache.org/docs/guide/development) |
589589

590590
### Protocol Specifications
591591

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- For Java Object Graph Guide, see [java serialization guide](guide/java_serialization_guide.md) doc.
55
- For Row Format Guide, see [row format guide](guide/row_format_guide.md) doc.
66
- For Scala Guide, see [scala guide](guide/scala_guide.md) doc.
7-
- For using Apache Fory™ with GraalVM native image, see [graalvm native image guide](guide/graalvm_guide.md) doc.
7+
- For using Apache Fory™ with GraalVM native image, see [graalvm support](guide/java/graalvm_support.md) doc.
88

99
## Fory IDL Schema
1010

docs/guide/java/advanced-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Advanced Features
3-
sidebar_position: 10
3+
sidebar_position: 11
44
id: advanced_features
55
license: |
66
Licensed to the Apache Software Foundation (ASF) under one or more

docs/guide/java/basic-serialization.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ System.out.println(fory.deserialize(bytes));
7373

7474
Fory provides efficient deep copy functionality:
7575

76+
For the full copy semantics, custom copy hooks, and troubleshooting guidance, see
77+
[Object Copy](object-copy.md).
78+
7679
### With Reference Tracking
7780

7881
```java
@@ -123,5 +126,6 @@ MyClass obj = fory.deserialize(bytes, MyClass.class);
123126
## Related Topics
124127

125128
- [Configuration](configuration.md) - All ForyBuilder options
129+
- [Object Copy](object-copy.md) - Deep-copy semantics and custom copy hooks
126130
- [Type Registration](type-registration.md) - Class registration
127131
- [Troubleshooting](troubleshooting.md) - Common API usage issues

docs/guide/java/cross-language.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Cross-Language Serialization
3-
sidebar_position: 11
3+
sidebar_position: 12
44
id: cross_language
55
license: |
66
Licensed to the Apache Software Foundation (ASF) under one or more
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: GraalVM Guide
3-
sidebar_position: 19
4-
id: serialization
2+
title: GraalVM Support
3+
sidebar_position: 13
4+
id: graalvm_support
55
license: |
66
Licensed to the Apache Software Foundation (ASF) under one or more
77
contributor license agreements. See the NOTICE file distributed with

docs/guide/java/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,10 @@ ThreadSafeFory threadLocalFory = Fory.builder()
203203
- [Field Configuration](field-configuration.md) - `@ForyField`, `@Ignore`, and integer encoding annotations
204204
- [Enum Configuration](enum-configuration.md) - `serializeEnumByName` and `@ForyEnumId`
205205
- [Basic Serialization](basic-serialization.md) - Detailed serialization patterns
206+
- [Object Copy](object-copy.md) - Deep-copy Java object graphs in memory
206207
- [Compression](compression.md) - Integer, long, and array compression options
207208
- [Virtual Threads](virtual-threads.md) - Virtual-thread usage and pool sizing guidance
208209
- [Type Registration](type-registration.md) - Class registration and security
209210
- [Custom Serializers](custom-serializers.md) - Implement custom serializers
210211
- [Cross-Language Serialization](cross-language.md) - Serialize data for other languages
212+
- [GraalVM Support](graalvm_support.md) - Build-time serializer compilation for native images

docs/guide/java/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Migration Guide
3-
sidebar_position: 13
3+
sidebar_position: 15
44
id: migration
55
license: |
66
Licensed to the Apache Software Foundation (ASF) under one or more

0 commit comments

Comments
 (0)