Skip to content

Commit 26e599b

Browse files
authored
docs: adjust doc links and sync config (#3136)
## Why? <!-- Describe the purpose of this PR. --> ## What does this PR do? apache/fory-site#387 refactored code sturcture, now relative links can be resolverd correctly. We can change back relative path now. ## Related issues apache/fory-site#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. -->
1 parent df8d5d6 commit 26e599b

File tree

12 files changed

+32
-32
lines changed

12 files changed

+32
-32
lines changed

.github/sync.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
apache/fory-site@main:
1919
- source: docs/guide/
20-
dest: docs/docs/guide/
20+
dest: docs/guide/
2121
- source: docs/specification/
2222
dest: docs/specification/
2323
- source: docs/benchmarks/

docs/guide/go/cross-language.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ user = fory.deserialize(data)
7676

7777
## Type Mapping
7878

79-
See [Type Mapping Specification](https://fory.apache.org/docs/specification/xlang_type_mapping) for detailed type mappings across all languages.
79+
See [Type Mapping Specification](../../specification/xlang_type_mapping.md) for detailed type mappings across all languages.
8080

8181
## Field Ordering
8282

@@ -278,5 +278,5 @@ Ensure other languages handle null appropriately.
278278
- [Type Registration](type-registration.md)
279279
- [Supported Types](supported-types.md)
280280
- [Schema Evolution](schema-evolution.md)
281-
- [Xlang Serialization Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec/)
282-
- [Type Mapping Specification](https://fory.apache.org/docs/specification/xlang_type_mapping)
281+
- [Xlang Serialization Specification](../../specification/xlang_serialization_spec.md)
282+
- [Type Mapping Specification](../../specification/xlang_type_mapping.md)

docs/guide/go/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,6 @@ See [Cross-Language Serialization](cross-language.md) for type mapping and compa
159159

160160
## Related Resources
161161

162-
- [Xlang Serialization Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec)
163-
- [Cross-Language Type Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping)
162+
- [Xlang Serialization Specification](../../specification/xlang_serialization_spec.md)
163+
- [Cross-Language Type Mapping](../../specification/xlang_type_mapping.md)
164164
- [GitHub Repository](https://github.com/apache/fory)

docs/guide/java/cross-language.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Not all Java types have equivalents in other languages. When using xlang mode:
159159
- Use **primitive types** (`int`, `long`, `double`, `String`) for maximum compatibility
160160
- Use **standard collections** (`List`, `Map`, `Set`) instead of language-specific ones
161161
- Avoid **Java-specific types** like `Optional`, `BigDecimal` (unless the target language supports them)
162-
- See [Type Mapping Guide](https://fory.apache.org/docs/specification/xlang_type_mapping) for complete compatibility matrix
162+
- See [Type Mapping Guide](../../specification/xlang_type_mapping.md) for complete compatibility matrix
163163

164164
### Compatible Types
165165

@@ -210,7 +210,7 @@ Cross-language mode has additional overhead compared to Java-only mode:
210210
### "Type mismatch" errors
211211

212212
- Ensure field types are compatible across languages
213-
- Review [Type Mapping Guide](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
213+
- Review [Type Mapping Guide](../../specification/xlang_type_mapping.md)
214214

215215
### Data corruption or unexpected values
216216

@@ -219,8 +219,8 @@ Cross-language mode has additional overhead compared to Java-only mode:
219219

220220
## See Also
221221

222-
- [Cross-Language Serialization Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
223-
- [Type Mapping Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
222+
- [Cross-Language Serialization Specification](../../specification/xlang_serialization_spec.md)
223+
- [Type Mapping Reference](../../specification/xlang_type_mapping.md)
224224
- [Python Cross-Language Guide](../python/cross-language.md)
225225
- [Rust Cross-Language Guide](../rust/cross-language.md)
226226

docs/guide/python/cross-language.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ The binary protocol and API are similar to `pyfory`'s python-native mode, but Py
128128

129129
## See Also
130130

131-
- [Cross-Language Serialization Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
132-
- [Type Mapping Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
131+
- [Cross-Language Serialization Specification](../../specification/xlang_serialization_spec.md)
132+
- [Type Mapping Reference](../../specification/xlang_type_mapping.md)
133133
- [Java Cross-Language Guide](../java/cross-language.md)
134134
- [Rust Cross-Language Guide](../rust/cross-language.md)
135135

docs/guide/rust/cross-language.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ person = fory.deserialize(bytes_from_rust)
129129

130130
## Type Mapping
131131

132-
See [xlang_type_mapping.md](https://fory.apache.org/docs/specification/xlang_type_mapping) for complete type mapping across languages.
132+
See [xlang_type_mapping.md](../../specification/xlang_type_mapping.md) for complete type mapping across languages.
133133

134134
### Common Type Mappings
135135

@@ -153,8 +153,8 @@ See [xlang_type_mapping.md](https://fory.apache.org/docs/specification/xlang_typ
153153

154154
## See Also
155155

156-
- [Cross-Language Serialization Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec)
157-
- [Type Mapping Reference](https://fory.apache.org/docs/next/specification/xlang_type_mapping)
156+
- [Cross-Language Serialization Specification](../../specification/xlang_serialization_spec.md)
157+
- [Type Mapping Reference](../../specification/xlang_type_mapping.md)
158158
- [Java Cross-Language Guide](../java/cross-language.md)
159159
- [Python Cross-Language Guide](../python/cross-language.md)
160160

docs/guide/xlang/field-nullability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,5 +247,5 @@ Schema B: { name: String (nullable) }
247247
248248
- [Reference Tracking](field-reference-tracking.md) - Shared and circular reference handling
249249
- [Serialization](serialization.md) - Basic cross-language serialization
250-
- [Type Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) - Cross-language type mapping reference
251-
- [Xlang Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec) - Binary protocol details
250+
- [Type Mapping](../../specification/xlang_type_mapping.md) - Cross-language type mapping reference
251+
- [Xlang Specification](../../specification/xlang_serialization_spec.md) - Binary protocol details

docs/guide/xlang/field-reference-tracking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,4 +257,4 @@ b.next = a; // Circular reference
257257

258258
- [Field Nullability](field-nullability.md) - How nullability affects serialization
259259
- [Serialization](serialization.md) - Basic cross-language serialization examples
260-
- [Xlang Specification](https://fory.apache.org/docs/specification/fory_xlang_serialization_spec) - Binary protocol details
260+
- [Xlang Specification](../../specification/xlang_serialization_spec.md) - Binary protocol details

docs/guide/xlang/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,6 @@ print(f"Name: {person.name}, Age: {person.age}")
287287

288288
## Next Steps
289289

290-
- [Type Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) - Cross-language type mapping reference
290+
- [Type Mapping](../../specification/xlang_type_mapping.md) - Cross-language type mapping reference
291291
- [Serialization](serialization.md) - Detailed serialization examples
292292
- [Troubleshooting](troubleshooting.md) - Common issues and solutions

docs/guide/xlang/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,14 @@ print(f"{person.name}, {person.age}") # Alice, 30
101101

102102
## Documentation
103103

104-
| Topic | Description |
105-
| ----------------------------------------------------------------------------- | ------------------------------------------------ |
106-
| [Getting Started](getting-started.md) | Installation and basic setup for all languages |
107-
| [Type Mapping](https://fory.apache.org/docs/specification/xlang_type_mapping) | Cross-language type mapping reference |
108-
| [Serialization](serialization.md) | Built-in types, custom types, reference handling |
109-
| [Zero-Copy](zero-copy.md) | Out-of-band serialization for large data |
110-
| [Row Format](row_format.md) | Cache-friendly binary format with random access |
111-
| [Troubleshooting](troubleshooting.md) | Common issues and solutions |
104+
| Topic | Description |
105+
| --------------------------------------------------------- | ------------------------------------------------ |
106+
| [Getting Started](getting-started.md) | Installation and basic setup for all languages |
107+
| [Type Mapping](../../specification/xlang_type_mapping.md) | Cross-language type mapping reference |
108+
| [Serialization](serialization.md) | Built-in types, custom types, reference handling |
109+
| [Zero-Copy](zero-copy.md) | Out-of-band serialization for large data |
110+
| [Row Format](row_format.md) | Cache-friendly binary format with random access |
111+
| [Troubleshooting](troubleshooting.md) | Common issues and solutions |
112112

113113
## Language-Specific Guides
114114

@@ -121,5 +121,5 @@ For language-specific details and API reference:
121121

122122
## Specifications
123123

124-
- [Xlang Serialization Specification](https://fory.apache.org/docs/next/specification/fory_xlang_serialization_spec) - Binary protocol details
125-
- [Type Mapping Specification](https://fory.apache.org/docs/next/specification/xlang_type_mapping) - Complete type mapping reference
124+
- [Xlang Serialization Specification](../../specification/xlang_serialization_spec.md) - Binary protocol details
125+
- [Type Mapping Specification](../../specification/xlang_type_mapping.md) - Complete type mapping reference

0 commit comments

Comments
 (0)