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 c379ed958 docs(go): fix broken go doc links (#3127)
c379ed958 is described below
commit c379ed958634012bce277b0049c30bf962c55151
Author: Shawn Yang <[email protected]>
AuthorDate: Mon Jan 12 13:58:27 2026 +0800
docs(go): fix broken go doc links (#3127)
## Why?
## What does this PR do?
## Related issues
#3121
## 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
---
docs/guide/go/basic-serialization.md | 14 +++++++-------
docs/guide/go/codegen.md | 6 +++---
docs/guide/go/configuration.md | 14 +++++++-------
docs/guide/go/cross-language.md | 6 +++---
docs/guide/go/custom-serializers.md | 6 +++---
docs/guide/go/index.md | 34 +++++++++++++++++-----------------
docs/guide/go/references.md | 8 ++++----
docs/guide/go/schema-evolution.md | 6 +++---
docs/guide/go/struct-tags.md | 6 +++---
docs/guide/go/supported-types.md | 8 ++++----
docs/guide/go/thread-safety.md | 6 +++---
docs/guide/go/troubleshooting.md | 8 ++++----
docs/guide/go/type-registration.md | 10 +++++-----
13 files changed, 66 insertions(+), 66 deletions(-)
diff --git a/docs/guide/go/basic-serialization.md
b/docs/guide/go/basic-serialization.md
index 130e444eb..7e6062e06 100644
--- a/docs/guide/go/basic-serialization.md
+++ b/docs/guide/go/basic-serialization.md
@@ -41,9 +41,9 @@ f.RegisterNamedStruct(User{}, "example.User")
f.RegisterEnum(Color(0), 3)
```
-**Important**: The Fory instance should be reused across serialization calls.
Creating a new instance involves allocating internal buffers, type caches, and
resolvers, which is expensive. The default Fory instance is not thread-safe;
for concurrent usage, use the thread-safe wrapper (see [Thread
Safety](thread-safety)).
+**Important**: The Fory instance should be reused across serialization calls.
Creating a new instance involves allocating internal buffers, type caches, and
resolvers, which is expensive. The default Fory instance is not thread-safe;
for concurrent usage, use the thread-safe wrapper (see [Thread
Safety](thread-safety.md)).
-See [Type Registration](type-registration) for more details.
+See [Type Registration](type-registration.md) for more details.
## Core API
@@ -304,7 +304,7 @@ Common error kinds:
- `ErrKindMaxDepthExceeded`: Recursion depth limit exceeded
- `ErrKindHashMismatch`: Struct hash mismatch (schema changed)
-See [Troubleshooting](troubleshooting) for error resolution.
+See [Troubleshooting](troubleshooting.md) for error resolution.
## Nil Handling
@@ -398,7 +398,7 @@ func main() {
## Related Topics
-- [Configuration](configuration)
-- [Type Registration](type-registration)
-- [Supported Types](supported-types)
-- [References](references)
+- [Configuration](configuration.md)
+- [Type Registration](type-registration.md)
+- [Supported Types](supported-types.md)
+- [References](references.md)
diff --git a/docs/guide/go/codegen.md b/docs/guide/go/codegen.md
index dd08a751b..04809dedb 100644
--- a/docs/guide/go/codegen.md
+++ b/docs/guide/go/codegen.md
@@ -415,6 +415,6 @@ For libraries: yes. For applications: either works.
## Related Topics
-- [Basic Serialization](basic-serialization)
-- [Configuration](configuration)
-- [Troubleshooting](troubleshooting)
+- [Basic Serialization](basic-serialization.md)
+- [Configuration](configuration.md)
+- [Troubleshooting](troubleshooting.md)
diff --git a/docs/guide/go/configuration.md b/docs/guide/go/configuration.md
index f9414a7c6..7e427f6e9 100644
--- a/docs/guide/go/configuration.md
+++ b/docs/guide/go/configuration.md
@@ -80,7 +80,7 @@ f := fory.New(fory.WithTrackRef(true))
- Same object is referenced multiple times
- Serializing graph structures (trees with parent pointers, linked lists with
cycles)
-See [References](references) for details.
+See [References](references.md) for details.
### WithCompatible
@@ -104,7 +104,7 @@ f := fory.New(fory.WithCompatible(true))
- Fields matched by sorted order
- Requires consistent struct definitions across all services
-See [Schema Evolution](schema-evolution) for details.
+See [Schema Evolution](schema-evolution.md) for details.
### WithMaxDepth
@@ -179,7 +179,7 @@ data, err := threadsafe.Marshal(&myValue)
err = threadsafe.Unmarshal(data, &result)
```
-See [Thread Safety](thread-safety) for details.
+See [Thread Safety](thread-safety.md) for details.
## Buffer Management
@@ -338,7 +338,7 @@ for req := range requests {
## Related Topics
-- [Basic Serialization](basic-serialization)
-- [References](references)
-- [Schema Evolution](schema-evolution)
-- [Thread Safety](thread-safety)
+- [Basic Serialization](basic-serialization.md)
+- [References](references.md)
+- [Schema Evolution](schema-evolution.md)
+- [Thread Safety](thread-safety.md)
diff --git a/docs/guide/go/cross-language.md b/docs/guide/go/cross-language.md
index f10fa97c5..f0ba90b73 100644
--- a/docs/guide/go/cross-language.md
+++ b/docs/guide/go/cross-language.md
@@ -275,8 +275,8 @@ Ensure other languages handle null appropriately.
## Related Topics
-- [Type Registration](type-registration)
-- [Supported Types](supported-types)
-- [Schema Evolution](schema-evolution)
+- [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)
diff --git a/docs/guide/go/custom-serializers.md
b/docs/guide/go/custom-serializers.md
index 3bf940faf..296f847b9 100644
--- a/docs/guide/go/custom-serializers.md
+++ b/docs/guide/go/custom-serializers.md
@@ -280,6 +280,6 @@ func TestMySerializer(t *testing.T) {
## Related Topics
-- [Type Registration](type-registration)
-- [Supported Types](supported-types)
-- [Cross-Language Serialization](cross-language)
+- [Type Registration](type-registration.md)
+- [Supported Types](supported-types.md)
+- [Cross-Language Serialization](cross-language.md)
diff --git a/docs/guide/go/index.md b/docs/guide/go/index.md
index cbfe87afe..9c60cc4f7 100644
--- a/docs/guide/go/index.md
+++ b/docs/guide/go/index.md
@@ -97,7 +97,7 @@ data, _ := f.Serialize(myStruct)
### Code Generation (Experimental)
-For performance-critical paths, Fory provides optional ahead-of-time code
generation that eliminates reflection overhead. See the [Code
Generation](codegen) guide for details.
+For performance-critical paths, Fory provides optional ahead-of-time code
generation that eliminates reflection overhead. See the [Code
Generation](codegen.md) guide for details.
## Configuration
@@ -111,7 +111,7 @@ f := fory.New(
)
```
-See [Configuration](configuration) for all available options.
+See [Configuration](configuration.md) for all available options.
## Supported Types
@@ -123,7 +123,7 @@ Fory Go supports a wide range of types:
- **Pointers**: pointer types with automatic nil handling
- **Structs**: any struct with exported fields
-See [Supported Types](supported-types) for the complete type mapping.
+See [Supported Types](supported-types.md) for the complete type mapping.
## Cross-Language Serialization
@@ -137,23 +137,23 @@ data, _ := f.Serialize(&User{ID: 1, Name: "Alice"})
// 'data' can be deserialized by Java, Python, etc.
```
-See [Cross-Language Serialization](cross-language) for type mapping and
compatibility details.
+See [Cross-Language Serialization](cross-language.md) for type mapping and
compatibility details.
## Documentation
-| Topic | Description
|
-| ------------------------------------------ |
-------------------------------------- |
-| [Configuration](configuration) | Options and settings
|
-| [Basic Serialization](basic-serialization) | Core APIs and usage patterns
|
-| [Type Registration](type-registration) | Registering types for
serialization |
-| [Supported Types](supported-types) | Complete type support reference
|
-| [References](references) | Circular references and shared
objects |
-| [Struct Tags](struct-tags) | Field-level configuration
|
-| [Schema Evolution](schema-evolution) | Forward/backward compatibility
|
-| [Cross-Language](cross-language) | Multi-language serialization
|
-| [Code Generation](codegen) | Experimental AOT code
generation |
-| [Thread Safety](thread-safety) | Concurrent usage patterns
|
-| [Troubleshooting](troubleshooting) | Common issues and solutions
|
+| Topic | Description
|
+| --------------------------------------------- |
-------------------------------------- |
+| [Configuration](configuration.md) | Options and settings
|
+| [Basic Serialization](basic-serialization.md) | Core APIs and usage patterns
|
+| [Type Registration](type-registration.md) | Registering types for
serialization |
+| [Supported Types](supported-types.md) | Complete type support
reference |
+| [References](references.md) | Circular references and
shared objects |
+| [Struct Tags](struct-tags.md) | Field-level configuration
|
+| [Schema Evolution](schema-evolution.md) | Forward/backward
compatibility |
+| [Cross-Language](cross-language.md) | Multi-language serialization
|
+| [Code Generation](codegen.md) | Experimental AOT code
generation |
+| [Thread Safety](thread-safety.md) | Concurrent usage patterns
|
+| [Troubleshooting](troubleshooting.md) | Common issues and solutions
|
## Related Resources
diff --git a/docs/guide/go/references.md b/docs/guide/go/references.md
index c1b34d2f6..928934de6 100644
--- a/docs/guide/go/references.md
+++ b/docs/guide/go/references.md
@@ -109,7 +109,7 @@ type Container struct {
- Pointer to primitive types (e.g., `*int`, `*string`) cannot use this tag
- Default is `ref=false` (no reference tracking per field)
-See [Struct Tags](struct-tags) for more details.
+See [Struct Tags](struct-tags.md) for more details.
## Circular References
@@ -351,6 +351,6 @@ func main() {
## Related Topics
-- [Configuration](configuration)
-- [Struct Tags](struct-tags)
-- [Cross-Language Serialization](cross-language)
+- [Configuration](configuration.md)
+- [Struct Tags](struct-tags.md)
+- [Cross-Language Serialization](cross-language.md)
diff --git a/docs/guide/go/schema-evolution.md
b/docs/guide/go/schema-evolution.md
index 5624e8104..09b85989c 100644
--- a/docs/guide/go/schema-evolution.md
+++ b/docs/guide/go/schema-evolution.md
@@ -335,6 +335,6 @@ func main() {
## Related Topics
-- [Configuration](configuration)
-- [Cross-Language Serialization](cross-language)
-- [Troubleshooting](troubleshooting)
+- [Configuration](configuration.md)
+- [Cross-Language Serialization](cross-language.md)
+- [Troubleshooting](troubleshooting.md)
diff --git a/docs/guide/go/struct-tags.md b/docs/guide/go/struct-tags.md
index 6075848ef..e7e9b7f7a 100644
--- a/docs/guide/go/struct-tags.md
+++ b/docs/guide/go/struct-tags.md
@@ -330,6 +330,6 @@ type Session struct {
## Related Topics
-- [References](references)
-- [Basic Serialization](basic-serialization)
-- [Schema Evolution](schema-evolution)
+- [References](references.md)
+- [Basic Serialization](basic-serialization.md)
+- [Schema Evolution](schema-evolution.md)
diff --git a/docs/guide/go/supported-types.md b/docs/guide/go/supported-types.md
index 9f048e210..06adb19bc 100644
--- a/docs/guide/go/supported-types.md
+++ b/docs/guide/go/supported-types.md
@@ -349,7 +349,7 @@ data, _ := f.Serialize(status)
| `time.Time` | Instant | datetime | - | -
|
| `time.Duration` | Duration | timedelta | - | -
|
-See [Cross-Language Serialization](cross-language) for detailed mapping.
+See [Cross-Language Serialization](cross-language.md) for detailed mapping.
## Unsupported Types
@@ -364,6 +364,6 @@ Attempting to serialize these types will result in an error.
## Related Topics
-- [Type Registration](type-registration)
-- [Cross-Language Serialization](cross-language)
-- [References](references)
+- [Type Registration](type-registration.md)
+- [Cross-Language Serialization](cross-language.md)
+- [References](references.md)
diff --git a/docs/guide/go/thread-safety.md b/docs/guide/go/thread-safety.md
index 1f475b3a1..a6543572e 100644
--- a/docs/guide/go/thread-safety.md
+++ b/docs/guide/go/thread-safety.md
@@ -342,6 +342,6 @@ go func() {
## Related Topics
-- [Configuration](configuration)
-- [Basic Serialization](basic-serialization)
-- [Troubleshooting](troubleshooting)
+- [Configuration](configuration.md)
+- [Basic Serialization](basic-serialization.md)
+- [Troubleshooting](troubleshooting.md)
diff --git a/docs/guide/go/troubleshooting.md b/docs/guide/go/troubleshooting.md
index f6cd38875..8f72f29fc 100644
--- a/docs/guide/go/troubleshooting.md
+++ b/docs/guide/go/troubleshooting.md
@@ -442,7 +442,7 @@ If you encounter issues not covered here:
## Related Topics
-- [Configuration](configuration)
-- [Cross-Language Serialization](cross-language)
-- [Schema Evolution](schema-evolution)
-- [Thread Safety](thread-safety)
+- [Configuration](configuration.md)
+- [Cross-Language Serialization](cross-language.md)
+- [Schema Evolution](schema-evolution.md)
+- [Thread Safety](thread-safety.md)
diff --git a/docs/guide/go/type-registration.md
b/docs/guide/go/type-registration.md
index 87090d604..1aa209719 100644
--- a/docs/guide/go/type-registration.md
+++ b/docs/guide/go/type-registration.md
@@ -109,7 +109,7 @@ err := f.RegisterExtension(CustomType{}, 1,
&CustomSerializer{})
err = f.RegisterNamedExtension(CustomType{}, "example.Custom",
&CustomSerializer{})
```
-See [Custom Serializers](custom-serializers) for details on implementing the
`ExtensionSerializer` interface.
+See [Custom Serializers](custom-serializers.md) for details on implementing
the `ExtensionSerializer` interface.
## Registration Scope
@@ -256,7 +256,7 @@ Two types registered with the same ID will conflict.
## Related Topics
-- [Basic Serialization](basic-serialization)
-- [Cross-Language Serialization](cross-language)
-- [Supported Types](supported-types)
-- [Troubleshooting](troubleshooting)
+- [Basic Serialization](basic-serialization.md)
+- [Cross-Language Serialization](cross-language.md)
+- [Supported Types](supported-types.md)
+- [Troubleshooting](troubleshooting.md)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
