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.git
The following commit(s) were added to refs/heads/main by this push:
new 26e599b13 docs: adjust doc links and sync config (#3136)
26e599b13 is described below
commit 26e599b13d3cd730a44ca3be89c59d94dce697c9
Author: Shawn Yang <[email protected]>
AuthorDate: Mon Jan 12 20:38:06 2026 +0800
docs: adjust doc links and sync config (#3136)
## Why?
<!-- Describe the purpose of this PR. -->
## What does this PR do?
https://github.com/apache/fory-site/pull/387 refactored code sturcture,
now relative links can be resolverd correctly. We can change back
relative path now.
## Related issues
https://github.com/apache/fory-site/pull/387
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fory/issues/new/choose) describing the
need to do so and update the document if necessary.
Delete section if not applicable.
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
Delete section if not applicable.
-->
---
.github/sync.yml | 2 +-
docs/guide/go/cross-language.md | 6 +++---
docs/guide/go/index.md | 4 ++--
docs/guide/java/cross-language.md | 8 ++++----
docs/guide/python/cross-language.md | 4 ++--
docs/guide/rust/cross-language.md | 6 +++---
docs/guide/xlang/field-nullability.md | 4 ++--
docs/guide/xlang/field-reference-tracking.md | 2 +-
docs/guide/xlang/getting-started.md | 2 +-
docs/guide/xlang/index.md | 20 ++++++++++----------
docs/guide/xlang/serialization.md | 4 ++--
docs/guide/xlang/troubleshooting.md | 2 +-
12 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/.github/sync.yml b/.github/sync.yml
index a6e1ebcf9..3acf33e82 100644
--- a/.github/sync.yml
+++ b/.github/sync.yml
@@ -17,7 +17,7 @@
apache/fory-site@main:
- source: docs/guide/
- dest: docs/docs/guide/
+ dest: docs/guide/
- source: docs/specification/
dest: docs/specification/
- source: docs/benchmarks/
diff --git a/docs/guide/go/cross-language.md b/docs/guide/go/cross-language.md
index f0ba90b73..b07716bad 100644
--- a/docs/guide/go/cross-language.md
+++ b/docs/guide/go/cross-language.md
@@ -76,7 +76,7 @@ user = fory.deserialize(data)
## Type Mapping
-See [Type Mapping
Specification](https://fory.apache.org/docs/specification/xlang_type_mapping)
for detailed type mappings across all languages.
+See [Type Mapping Specification](../../specification/xlang_type_mapping.md)
for detailed type mappings across all languages.
## Field Ordering
@@ -278,5 +278,5 @@ Ensure other languages handle null appropriately.
- [Type Registration](type-registration.md)
- [Supported Types](supported-types.md)
- [Schema Evolution](schema-evolution.md)
-- [Xlang Serialization
Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec/)
-- [Type Mapping
Specification](https://fory.apache.org/docs/specification/xlang_type_mapping)
+- [Xlang Serialization
Specification](../../specification/xlang_serialization_spec.md)
+- [Type Mapping Specification](../../specification/xlang_type_mapping.md)
diff --git a/docs/guide/go/index.md b/docs/guide/go/index.md
index ee0b57c57..d4e256747 100644
--- a/docs/guide/go/index.md
+++ b/docs/guide/go/index.md
@@ -159,6 +159,6 @@ See [Cross-Language Serialization](cross-language.md) for
type mapping and compa
## Related Resources
-- [Xlang Serialization
Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec)
-- [Cross-Language Type
Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping)
+- [Xlang Serialization
Specification](../../specification/xlang_serialization_spec.md)
+- [Cross-Language Type Mapping](../../specification/xlang_type_mapping.md)
- [GitHub Repository](https://github.com/apache/fory)
diff --git a/docs/guide/java/cross-language.md
b/docs/guide/java/cross-language.md
index 1c212eb0b..569be4a52 100644
--- a/docs/guide/java/cross-language.md
+++ b/docs/guide/java/cross-language.md
@@ -159,7 +159,7 @@ Not all Java types have equivalents in other languages.
When using xlang mode:
- Use **primitive types** (`int`, `long`, `double`, `String`) for maximum
compatibility
- Use **standard collections** (`List`, `Map`, `Set`) instead of
language-specific ones
- Avoid **Java-specific types** like `Optional`, `BigDecimal` (unless the
target language supports them)
-- See [Type Mapping
Guide](https://fory.apache.org/docs/specification/xlang_type_mapping) for
complete compatibility matrix
+- See [Type Mapping Guide](../../specification/xlang_type_mapping.md) for
complete compatibility matrix
### Compatible Types
@@ -210,7 +210,7 @@ Cross-language mode has additional overhead compared to
Java-only mode:
### "Type mismatch" errors
- Ensure field types are compatible across languages
-- Review [Type Mapping
Guide](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
+- Review [Type Mapping Guide](../../specification/xlang_type_mapping.md)
### Data corruption or unexpected values
@@ -219,8 +219,8 @@ Cross-language mode has additional overhead compared to
Java-only mode:
## See Also
-- [Cross-Language Serialization
Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
-- [Type Mapping
Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
+- [Cross-Language Serialization
Specification](../../specification/xlang_serialization_spec.md)
+- [Type Mapping Reference](../../specification/xlang_type_mapping.md)
- [Python Cross-Language Guide](../python/cross-language.md)
- [Rust Cross-Language Guide](../rust/cross-language.md)
diff --git a/docs/guide/python/cross-language.md
b/docs/guide/python/cross-language.md
index e24450c15..34624f821 100644
--- a/docs/guide/python/cross-language.md
+++ b/docs/guide/python/cross-language.md
@@ -128,8 +128,8 @@ The binary protocol and API are similar to `pyfory`'s
python-native mode, but Py
## See Also
-- [Cross-Language Serialization
Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
-- [Type Mapping
Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
+- [Cross-Language Serialization
Specification](../../specification/xlang_serialization_spec.md)
+- [Type Mapping Reference](../../specification/xlang_type_mapping.md)
- [Java Cross-Language Guide](../java/cross-language.md)
- [Rust Cross-Language Guide](../rust/cross-language.md)
diff --git a/docs/guide/rust/cross-language.md
b/docs/guide/rust/cross-language.md
index 96a4983b5..696150908 100644
--- a/docs/guide/rust/cross-language.md
+++ b/docs/guide/rust/cross-language.md
@@ -129,7 +129,7 @@ person = fory.deserialize(bytes_from_rust)
## Type Mapping
-See
[xlang_type_mapping.md](https://fory.apache.org/docs/specification/xlang_type_mapping)
for complete type mapping across languages.
+See [xlang_type_mapping.md](../../specification/xlang_type_mapping.md) for
complete type mapping across languages.
### Common Type Mappings
@@ -153,8 +153,8 @@ See
[xlang_type_mapping.md](https://fory.apache.org/docs/specification/xlang_typ
## See Also
-- [Cross-Language Serialization
Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
-- [Type Mapping
Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
+- [Cross-Language Serialization
Specification](../../specification/xlang_serialization_spec.md)
+- [Type Mapping Reference](../../specification/xlang_type_mapping.md)
- [Java Cross-Language Guide](../java/cross-language.md)
- [Python Cross-Language Guide](../python/cross-language.md)
diff --git a/docs/guide/xlang/field-nullability.md
b/docs/guide/xlang/field-nullability.md
index d3ba65bdc..9a66f0f1a 100644
--- a/docs/guide/xlang/field-nullability.md
+++ b/docs/guide/xlang/field-nullability.md
@@ -247,5 +247,5 @@ Schema B: { name: String (nullable) }
- [Reference Tracking](field-reference-tracking.md) - Shared and circular
reference handling
- [Serialization](serialization.md) - Basic cross-language serialization
-- [Type
Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) -
Cross-language type mapping reference
-- [Xlang
Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec)
- Binary protocol details
+- [Type Mapping](../../specification/xlang_type_mapping.md) - Cross-language
type mapping reference
+- [Xlang Specification](../../specification/xlang_serialization_spec.md) -
Binary protocol details
diff --git a/docs/guide/xlang/field-reference-tracking.md
b/docs/guide/xlang/field-reference-tracking.md
index 4e67ac5b2..4e2a59124 100644
--- a/docs/guide/xlang/field-reference-tracking.md
+++ b/docs/guide/xlang/field-reference-tracking.md
@@ -257,4 +257,4 @@ b.next = a; // Circular reference
- [Field Nullability](field-nullability.md) - How nullability affects
serialization
- [Serialization](serialization.md) - Basic cross-language serialization
examples
-- [Xlang
Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec)
- Binary protocol details
+- [Xlang Specification](../../specification/xlang_serialization_spec.md) -
Binary protocol details
diff --git a/docs/guide/xlang/getting-started.md
b/docs/guide/xlang/getting-started.md
index f2eb5e41f..5b77446a9 100644
--- a/docs/guide/xlang/getting-started.md
+++ b/docs/guide/xlang/getting-started.md
@@ -287,6 +287,6 @@ print(f"Name: {person.name}, Age: {person.age}")
## Next Steps
-- [Type
Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) -
Cross-language type mapping reference
+- [Type Mapping](../../specification/xlang_type_mapping.md) - Cross-language
type mapping reference
- [Serialization](serialization.md) - Detailed serialization examples
- [Troubleshooting](troubleshooting.md) - Common issues and solutions
diff --git a/docs/guide/xlang/index.md b/docs/guide/xlang/index.md
index 7a36c06dc..5cdcc5678 100644
--- a/docs/guide/xlang/index.md
+++ b/docs/guide/xlang/index.md
@@ -101,14 +101,14 @@ print(f"{person.name}, {person.age}") # Alice, 30
## Documentation
-| Topic
| Description |
-|
----------------------------------------------------------------------------- |
------------------------------------------------ |
-| [Getting Started](getting-started.md)
| Installation and basic setup for all languages |
-| [Type
Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) |
Cross-language type mapping reference |
-| [Serialization](serialization.md)
| Built-in types, custom types, reference handling |
-| [Zero-Copy](zero-copy.md)
| Out-of-band serialization for large data |
-| [Row Format](row_format.md)
| Cache-friendly binary format with random access |
-| [Troubleshooting](troubleshooting.md)
| Common issues and solutions |
+| Topic | Description
|
+| --------------------------------------------------------- |
------------------------------------------------ |
+| [Getting Started](getting-started.md) | Installation and
basic setup for all languages |
+| [Type Mapping](../../specification/xlang_type_mapping.md) | Cross-language
type mapping reference |
+| [Serialization](serialization.md) | Built-in types,
custom types, reference handling |
+| [Zero-Copy](zero-copy.md) | Out-of-band
serialization for large data |
+| [Row Format](row_format.md) | Cache-friendly
binary format with random access |
+| [Troubleshooting](troubleshooting.md) | Common issues
and solutions |
## Language-Specific Guides
@@ -121,5 +121,5 @@ For language-specific details and API reference:
## Specifications
-- [Xlang Serialization
Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
- Binary protocol details
-- [Type Mapping
Specification](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
- Complete type mapping reference
+- [Xlang Serialization
Specification](../../specification/xlang_serialization_spec.md) - Binary
protocol details
+- [Type Mapping Specification](../../specification/xlang_type_mapping.md) -
Complete type mapping reference
diff --git a/docs/guide/xlang/serialization.md
b/docs/guide/xlang/serialization.md
index a8d1c1b96..5a6d879bd 100644
--- a/docs/guide/xlang/serialization.md
+++ b/docs/guide/xlang/serialization.md
@@ -537,6 +537,6 @@ Circular references cannot be implemented in Rust due to
ownership restrictions.
## See Also
- [Zero-Copy Serialization](zero-copy.md) - Out-of-band serialization for
large data
-- [Type
Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) -
Cross-language type mapping reference
+- [Type Mapping](../../specification/xlang_type_mapping.md) - Cross-language
type mapping reference
- [Getting Started](getting-started.md) - Installation and setup
-- [Xlang Serialization
Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
- Binary protocol details
+- [Xlang Serialization
Specification](../../specification/xlang_serialization_spec.md) - Binary
protocol details
diff --git a/docs/guide/xlang/troubleshooting.md
b/docs/guide/xlang/troubleshooting.md
index dd3eed952..bba9d51e3 100644
--- a/docs/guide/xlang/troubleshooting.md
+++ b/docs/guide/xlang/troubleshooting.md
@@ -315,7 +315,7 @@ python deserializer.py data.bin
## See Also
-- [Type
Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) -
Cross-language type mapping reference
+- [Type Mapping](../../specification/xlang_type_mapping.md) - Cross-language
type mapping reference
- [Getting Started](getting-started.md) - Setup guide
- [Java Troubleshooting](../java/troubleshooting.md) - Java-specific issues
- [Python Troubleshooting](../python/troubleshooting.md) - Python-specific
issues
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
