This is an automated email from the ASF dual-hosted git repository. chaokunyang pushed a commit to branch fix_link_errors in repository https://gitbox.apache.org/repos/asf/fory-site.git
commit 18880330effc2196a4d6a1d29026778ef9b066fb Author: chaokunyang <[email protected]> AuthorDate: Wed Dec 10 23:11:57 2025 +0800 fix broken links --- docs/docs/guide/scala/index.md | 20 ++++++++++++++++++++ docs/docs/guide/xlang/index.md | 20 ++++++++++++++++++++ docs/docs/introduction/introduction.md | 18 +++++++++--------- docs/docs/start/usage.md | 14 +++++++------- 4 files changed, 56 insertions(+), 16 deletions(-) diff --git a/docs/docs/guide/scala/index.md b/docs/docs/guide/scala/index.md new file mode 100644 index 000000000..898ac01f4 --- /dev/null +++ b/docs/docs/guide/scala/index.md @@ -0,0 +1,20 @@ +--- +title: Scala Serialization Guide +sidebar_position: 0 +id: scala_serialization_index +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- diff --git a/docs/docs/guide/xlang/index.md b/docs/docs/guide/xlang/index.md new file mode 100644 index 000000000..59d60ef6d --- /dev/null +++ b/docs/docs/guide/xlang/index.md @@ -0,0 +1,20 @@ +--- +title: Cross Language +sidebar_position: 0 +id: xlang_serialization_index +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- diff --git a/docs/docs/introduction/introduction.md b/docs/docs/introduction/introduction.md index 3a3b7f205..bc7ef847a 100644 --- a/docs/docs/introduction/introduction.md +++ b/docs/docs/introduction/introduction.md @@ -67,14 +67,14 @@ All protocols share the same optimized codebase, allowing improvements in one pr | Guide | Description | Source | Website | | -------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| **Java Serialization** | Comprehensive guide for Java serialization | [java_serialization_guide.md](docs/guide/java_serialization_guide.md) | [π View](https://fory.apache.org/docs/docs/guide/java_serialization) | -| **Cross-Language Serialization** | Multi-language object exchange | [xlang_serialization_guide.md](docs/guide/xlang_serialization_guide.md) | [π View](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec) | -| **Row Format** | Zero-copy random access format | [row_format_guide.md](docs/guide/row_format_guide.md) | [π View](https://fory.apache.org/docs/specification/fory_row_format_spec) | -| **Python** | Python-specific features and usage | [python_guide.md](docs/guide/python_guide.md) | [π View](https://fory.apache.org/docs/docs/guide/python_serialization) | -| **Rust** | Rust implementation and patterns | [rust_guide.md](docs/guide/rust_guide.md) | [π View](https://fory.apache.org/docs/docs/guide/rust_serialization) | -| **Scala** | Scala integration and best practices | [scala_guide.md](docs/guide/scala_guide.md) | [π View](https://fory.apache.org/docs/docs/guide/scala_serialization) | -| **GraalVM** | Native image support and AOT compilation | [graalvm_guide.md](docs/guide/graalvm_guide.md) | [π View](https://fory.apache.org/docs/docs/guide/graalvm_serialization) | -| **Development** | Building and contributing to Fory | [DEVELOPMENT.md](docs/guide/DEVELOPMENT.md) | [π View](https://fory.apache.org/docs/docs/guide/development) | +| **Java Serialization** | Comprehensive guide for Java serialization | [Java Guide](../guide/java/index.md) | [π View](https://fory.apache.org/docs/docs/guide/java) | +| **Cross-Language Serialization** | Multi-language object exchange | [Xlang Guide](../guide/xlang/index.md) | [π View](https://fory.apache.org/docs/docs/guide/xlang) | +| **Row Format** | Zero-copy random access format | [Java Row Format](../guide/java/row-format.md) | [π View](https://fory.apache.org/docs/docs/guide/java/row-format) | +| **Python** | Python-specific features and usage | [Python Guide](../guide/python/index.md) | [π View](https://fory.apache.org/docs/docs/guide/python) | +| **Rust** | Rust implementation and patterns | [Rust Guide](../guide/rust/index.md) | [π View](https://fory.apache.org/docs/docs/guide/rust) | +| **Scala** | Scala integration and best practices | [Scala Guide](../guide/scala/index.md) | [π View](https://fory.apache.org/docs/docs/guide/scala) | +| **GraalVM** | Native image support and AOT compilation | [GraalVM Guide](../guide/graalvm_guide.md) | [π View](https://fory.apache.org/docs/docs/guide/graalvm_guide) | +| **Development** | Building and contributing to Fory | [Development](../guide/DEVELOPMENT.md) | [π View](https://fory.apache.org/docs/docs/guide/DEVELOPMENT) | ### Protocol Specifications @@ -103,7 +103,7 @@ Apache Foryβ’ supports class schema forward/backward compatibility across **Jav - Version your serialized data by Fory major version - Plan migration strategies when upgrading major versions -- See [upgrade guide](docs/guide/java_serialization_guide.md#upgrade-fory) for details +- See [upgrade guide](../guide/java/migration.md) for details **Future**: Binary compatibility will be guaranteed starting from Fory 1.0 release. diff --git a/docs/docs/start/usage.md b/docs/docs/start/usage.md index feba54fb1..cfccffc82 100644 --- a/docs/docs/start/usage.md +++ b/docs/docs/start/usage.md @@ -46,7 +46,7 @@ public class Example { } ``` -For detailed Java usage including compatibility modes, compression, and advanced features, see [Java Serialization Guide](docs/guide/java_serialization_guide.md). +For detailed Java usage including compatibility modes, compression, and advanced features, see [Java Serialization Guide](../guide/java/index.md). ### Python Serialization @@ -71,7 +71,7 @@ result = fory.deserialize(data) print(result.name, result.age) # Output: chaokunyang 28 ``` -For detailed Python usage including type hints, compatibility modes, and advanced features, see [Python Guide](docs/guide/python_guide.md). +For detailed Python usage including type hints, compatibility modes, and advanced features, see [Python Guide](../guide/python/index.md). ### Scala Serialization @@ -102,7 +102,7 @@ object Example { } ``` -For detailed Scala usage including collection serialization and integration patterns, see [Scala Guide](docs/guide/scala_guide.md). +For detailed Scala usage including collection serialization and integration patterns, see [Scala Guide](../guide/scala/index.md). ### Kotlin Serialization @@ -242,9 +242,9 @@ console.log(result); For examples with **circular references**, **shared references**, and **polymorphism** across languages, see: -- [Cross-Language Serialization Guide](docs/guide/xlang_serialization_guide.md) -- [Java Serialization Guide - Cross Language](docs/guide/java_serialization_guide.md#cross-language-serialization) -- [Python Guide - Cross Language](docs/guide/python_guide.md#cross-language-serialization) +- [Cross-Language Serialization Guide](../guide/xlang/index.md) +- [Java Serialization Guide - Cross Language](../guide/java/cross-language.md) +- [Python Guide - Cross Language](../guide/python/cross-language.md) ## Row Format Encoding @@ -340,4 +340,4 @@ print(foo_row.f4[100000].f1) # Access nested field print(foo_row.f4[200000].f2[5]) # Access deeply nested field ``` -For more details on row format, see [Row Format Guide](docs/guide/row_format_guide.md). +For more details on row format, see [Java Row Format Guide](../guide/java/row-format.md) or [Python Row Format Guide](../guide/python/row-format.md). --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
