Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/go/cross-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/guide/go/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
8 changes: 4 additions & 4 deletions docs/guide/java/cross-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/python/cross-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/rust/cross-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/xlang/field-nullability.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/guide/xlang/field-reference-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/guide/xlang/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 10 additions & 10 deletions docs/guide/xlang/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
4 changes: 2 additions & 2 deletions docs/guide/xlang/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/guide/xlang/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading