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-site.git
The following commit(s) were added to refs/heads/main by this push:
new 2ed73dffc3 Optimize website (#457)
2ed73dffc3 is described below
commit 2ed73dffc3c486f8e17cc1a03a3341facef4c4a1
Author: Shawn Yang <[email protected]>
AuthorDate: Fri May 22 02:34:24 2026 +0800
Optimize website (#457)
Co-authored-by: Shawn Yang <[email protected]>
---
docs/introduction/overview.md | 86 ----------
.../current/introduction/overview.md | 86 ----------
.../version-1.0.0/introduction/overview.md | 86 ----------
sidebars.ts | 1 -
src/css/custom.css | 183 ++++++++++++++++++++-
.../version-1.0.0/introduction/overview.md | 86 ----------
versioned_sidebars/version-1.0.0-sidebars.json | 4 -
7 files changed, 178 insertions(+), 354 deletions(-)
diff --git a/docs/introduction/overview.md b/docs/introduction/overview.md
index f33d9dd582..d72dbc04ec 100644
--- a/docs/introduction/overview.md
+++ b/docs/introduction/overview.md
@@ -4,11 +4,6 @@ title: Overview
sidebar_position: 1
---
-<div class="themed-logo">
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-dark.png"
class="themed-logo-dark"/>
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-light.png"
class="themed-logo-light"/>
-</div>
-
**Apache Fory™** is a blazingly-fast multi-language serialization framework for
idiomatic domain objects, schema IDL, and cross-language data exchange.
@@ -113,84 +108,3 @@ Fory keeps hot paths fast without making every runtime use
the same implementati
- **Generated and static serializers**: Other runtimes use generated or static
serializers where appropriate.
- **Zero-copy paths**: Row format and out-of-band buffers avoid unnecessary
copies for large values.
- **Metadata sharing**: Repeated type information is shared or packed to
reduce serialization overhead.
-
-### Production-Readiness
-
-Enterprise-grade security and compatibility:
-
-- **Class Registration**: Whitelist-based deserialization control (enabled by
default)
-- **Depth Limiting**: Protection against recursive object graph attacks
-- **Configurable Policies**: Custom class checkers and deserialization policies
-- **Platform Support**: Java 8-24, GraalVM native image, multiple OS platforms
-
-## Protocols
-
-Apache Fory™ implements multiple binary protocols optimized for different
scenarios:
-
-| Protocol |
Use Case | Key Features
|
-| ----------------------------------------------------------------------- |
------------------------------ |
------------------------------------------------------ |
-| **[Xlang Serialization](../specification/xlang_serialization_spec.md)** |
Cross-language object exchange | Automatic serialization, references,
polymorphism |
-| **[Java Serialization](../specification/java_serialization_spec.md)** |
High-performance Java-only | Java-native object graphs, JDK hooks,
optimized runtime |
-| **[Row Format](../specification/row_format_spec.md)** |
Analytics and data processing | Zero-copy random access, Arrow compatibility
|
-| **Python Native** |
Python-specific serialization | Pickle/cloudpickle replacement with better
performance |
-
-All protocols share the same optimized codebase, allowing improvements in one
protocol to benefit others.
-
-## Documentation
-
-### User Guides
-
-| Guide | Description
| Source
| Website |
-| -------------------------------- |
------------------------------------------ |
-----------------------------------------------------------------------------------------
| -------------------------------------- |
-| **Java Serialization** | Comprehensive guide for Java
serialization | [Java
Guide](https://github.com/apache/fory/blob/main/docs/guide/java/)
| [View](../guide/java) |
-| **Cross-Language Serialization** | Multi-language object exchange
| [Xlang Guide](https://github.com/apache/fory/blob/main/docs/guide/xlang/)
| [View](../guide/xlang) |
-| **Row Format** | Zero-copy random access format
| [Java Row
Format](https://github.com/apache/fory/blob/main/docs/guide/java/row-format.md)
| [View](../guide/java/row-format.md) |
-| **Python** | Python-specific features and usage
| [Python Guide](https://github.com/apache/fory/blob/main/docs/guide/python/)
| [View](../guide/python) |
-| **Rust** | Rust implementation and patterns
| [Rust Guide](https://github.com/apache/fory/blob/main/docs/guide/rust/)
| [View](../guide/rust) |
-| **Go** | Go implementation and usage
| [Go Guide](https://github.com/apache/fory/blob/main/docs/guide/go/)
| [View](../guide/go) |
-| **Scala** | Scala integration and best practices
| [Scala Guide](https://github.com/apache/fory/blob/main/docs/guide/scala/)
| [View](../guide/scala) |
-| **GraalVM** | Native image support and AOT compilation
| [GraalVM
Support](https://github.com/apache/fory/blob/main/docs/guide/java/graalvm-support.md)
| [View](../guide/java/graalvm_support) |
-| **Development** | Building and contributing to Fory
| [Development](https://github.com/apache/fory/blob/main/docs/DEVELOPMENT.md)
| [View](../community/DEVELOPMENT.md) |
-
-### Protocol Specifications
-
-| Specification | Description | Source
| Website |
-| ----------------------- | ------------------------------ |
----------------------------------------------------------------------------------------------------------------------
| ------------------------------------------------------- |
-| **Xlang Serialization** | Cross-language binary protocol |
[xlang_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_serialization_spec.md)
| [View](../specification/xlang_serialization_spec.md) |
-| **Java Serialization** | Java-optimized protocol |
[java_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/java_serialization_spec.md)
| [View](../specification/java_serialization_spec.md) |
-| **Row Format** | Row-based binary format |
[row_format_spec.md](https://github.com/apache/fory/blob/main/docs/specification/row_format_spec.md)
| [View](../specification/row_format_spec.md) |
-| **Type Mapping** | Cross-language type conversion |
[xlang_type_mapping.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_type_mapping.md)
| [View](../specification/xlang_type_mapping.md) |
-
-## Compatibility
-
-### Schema Compatibility
-
-Apache Fory™ supports class schema forward/backward compatibility across
**Java, Python, Rust, and Golang**, enabling seamless schema evolution in
production systems without requiring coordinated upgrades across all services.
Fory provides two schema compatibility modes:
-
-1. **Schema Consistent Mode (Default)**: Assumes identical class schemas
between serialization and deserialization peers. This mode offers minimal
serialization overhead, smallest data size, and fastest performance: ideal for
stable schemas or controlled environments.
-
-2. **Compatible Mode**: Supports independent schema evolution with forward and
backward compatibility. This mode enables field addition/deletion, limited type
evolution, and graceful handling of schema mismatches. Enable using
`withCompatibleMode(CompatibleMode.COMPATIBLE)` in Java, `compatible=True` in
Python, `compatible_mode(true)` in Rust, or `NewFory(true)` in Go.
-
-## Community and Support
-
-### Getting Help
-
-- **Slack**: Join our [Slack
workspace](https://join.slack.com/t/fory-project/shared_invite/zt-36g0qouzm-kcQSvV_dtfbtBKHRwT5gsw)
for community discussions
-- **Twitter/X**: Follow [@ApacheFory](https://x.com/ApacheFory) for updates
and announcements
-- **GitHub Issues**: Report bugs and request features at
[apache/fory](https://github.com/apache/fory/issues)
-- **Mailing Lists**: Subscribe to Apache Fory mailing lists for development
discussions
-
-### Contributing
-
-We welcome contributions! Please read our [Contributing
Guide](https://github.com/apache/fory/blob/main/CONTRIBUTING.md) to get started.
-
-**Ways to Contribute**:
-
-- Report bugs and issues
-- Propose new features
-- Improve documentation
-- Submit pull requests
-- Add test cases
-- Share benchmarks
-
-See [Development Guide](../community/DEVELOPMENT.md) for build instructions
and development workflow.
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/introduction/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/introduction/overview.md
index 11a0117912..929aa34ed4 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/introduction/overview.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/introduction/overview.md
@@ -4,11 +4,6 @@ title: 概述
sidebar_position: 1
---
-<div class="themed-logo">
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-dark.png"
class="themed-logo-dark"/>
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-light.png"
class="themed-logo-light"/>
-</div>
-
**Apache Fory™** 是一个高性能多语言序列化框架，面向原生对象序列化和跨语言二进制编解码，支持 Schema IDL、对象引用、Schema
演进、Row Format 随机访问与零拷贝读取。
Fory 面向跨语言、跨运行时的紧凑高吞吐序列化而构建。它可以直接处理应用中的对象；当需要稳定契约时，也可以使用共享
Schema；同时保留对象图中的共享引用、循环引用和多态运行时类型等语义。
@@ -105,84 +100,3 @@ Fory 让热点路径保持高速，同时不要求所有运行时采用相同实
- **生成式和静态序列化器**：其他运行时在合适场景下使用生成式或静态序列化器。
- **零拷贝路径**：行格式和带外 buffer 可避免大值的不必要复制。
- **元数据共享**：复用或打包重复类型信息，降低序列化开销。
-
-### 生产就绪
-
-企业级安全性和兼容性：
-
-- **类注册**：基于白名单的反序列化控制（默认启用）
-- **深度限制**：防止递归对象图攻击
-- **可配置策略**：自定义类检查器和反序列化策略
-- **平台支持**：Java 8-24、GraalVM 原生镜像、多操作系统平台
-
-## 协议
-
-Apache Fory™ 实现了针对不同场景优化的多个二进制协议：
-
-| 协议 | 使用场景
| 核心特性 |
-| ---------------------------------------------------------------- |
----------------- | --------------------------------- |
-| **[跨语言序列化](../specification/xlang_serialization_spec.md)** | 跨语言对象交换 |
自动序列化、引用、多态 |
-| **[Java 序列化](../specification/java_serialization_spec.md)** | 高性能 Java 专用
| Java 原生对象图、JDK 钩子、优化运行时 |
-| **[行格式](../specification/row_format_spec.md)** | 分析和数据处理 |
零拷贝随机访问、Arrow 兼容 |
-| **Python 原生** | Python
专用序列化 | Pickle/cloudpickle 替代，性能更好 |
-
-所有协议共享相同的优化代码库，一个协议的改进可以惠及其他协议。
-
-## 文档
-
-### 用户指南
-
-| 指南 | 描述 | 源文件
| 网站
|
-| ---------------- | ----------------------- |
-------------------------------------------------------------------------------------
| -------------------------------------- |
-| **Java 序列化** | Java 序列化综合指南 | [Java
指南](https://github.com/apache/fory/blob/main/docs/guide/java/) |
[查看](../guide/java) |
-| **跨语言序列化** | 多语言对象交换 | [Xlang
指南](https://github.com/apache/fory/blob/main/docs/guide/xlang/) |
[查看](../guide/xlang) |
-| **行格式** | 零拷贝随机访问格式 | [Java
行格式](https://github.com/apache/fory/blob/main/docs/guide/java/row-format.md) |
[查看](../guide/java/row-format.md) |
-| **Python** | Python 特定功能和用法 | [Python
指南](https://github.com/apache/fory/blob/main/docs/guide/python/) |
[查看](../guide/python) |
-| **Rust** | Rust 实现和模式 | [Rust
指南](https://github.com/apache/fory/blob/main/docs/guide/rust/) |
[查看](../guide/rust) |
-| **Go** | Go 实现和用法 | [Go
指南](https://github.com/apache/fory/blob/main/docs/guide/go/)
| [查看](../guide/go) |
-| **Scala** | Scala 集成和最佳实践 | [Scala
指南](https://github.com/apache/fory/blob/main/docs/guide/scala/) |
[查看](../guide/scala) |
-| **GraalVM** | 原生镜像支持和 AOT 编译 | [GraalVM
支持](https://github.com/apache/fory/blob/main/docs/guide/java/graalvm-support.md)
| [查看](../guide/java/graalvm_support) |
-| **开发** | 构建和贡献 Fory |
[开发指南](https://github.com/apache/fory/blob/main/docs/DEVELOPMENT.md)
| [查看](../community/DEVELOPMENT.md) |
-
-### 协议规范
-
-| 规范 | 描述 | 源文件
| 网站
|
-| ---------------- | ------------------ |
----------------------------------------------------------------------------------------------------------------------
| ------------------------------------------------------- |
-| **跨语言序列化** | 跨语言二进制协议 |
[xlang_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_serialization_spec.md)
| [查看](../specification/xlang_serialization_spec.md) |
-| **Java 序列化** | Java 优化协议 |
[java_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/java_serialization_spec.md)
| [查看](../specification/java_serialization_spec.md) |
-| **行格式** | 基于行的二进制格式 |
[row_format_spec.md](https://github.com/apache/fory/blob/main/docs/specification/row_format_spec.md)
| [查看](../specification/row_format_spec.md) |
-| **类型映射** | 跨语言类型转换 |
[xlang_type_mapping.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_type_mapping.md)
| [查看](../specification/xlang_type_mapping.md) |
-
-## 兼容性
-
-### Schema 兼容性
-
-Apache Fory™ 支持 **Java、Python、Rust 和 Golang** 的类 Schema 向前/向后兼容，支持生产系统中的无缝
Schema 演进，无需跨所有服务协调升级。Fory 提供两种 Schema 兼容性模式：
-
-1. **Schema 一致模式（默认）**：假设序列化和反序列化端之间的类 Schema
相同。此模式提供最小的序列化开销、最小的数据大小和最快的性能：适用于稳定的 Schema 或受控环境。
-
-2. **兼容模式**：支持独立的 Schema 演进，具有向前和向后兼容性。此模式支持字段添加/删除、有限的类型演进和优雅处理 Schema 不匹配。在
Java 中使用 `withCompatibleMode(CompatibleMode.COMPATIBLE)` 启用，在 Python 中使用
`compatible=True`，在 Rust 中使用 `compatible_mode(true)`，在 Go 中使用 `NewFory(true)`。
-
-## 社区与支持
-
-### 获取帮助
-
-- **Slack**：加入我们的 [Slack
工作区](https://join.slack.com/t/fory-project/shared_invite/zt-36g0qouzm-kcQSvV_dtfbtBKHRwT5gsw)参与社区讨论
-- **Twitter/X**：关注 [@ApacheFory](https://x.com/ApacheFory) 获取更新和公告
-- **GitHub Issues**：在 [apache/fory](https://github.com/apache/fory/issues)
报告错误和请求功能
-- **邮件列表**：订阅 Apache Fory 邮件列表参与开发讨论
-
-### 贡献
-
-我们欢迎贡献！请阅读我们的[贡献指南](https://github.com/apache/fory/blob/main/CONTRIBUTING.md)开始。
-
-**贡献方式**：
-
-- 报告错误和问题
-- 提出新功能
-- 改进文档
-- 提交 Pull Request
-- 添加测试用例
-- 分享基准测试
-
-详见[开发指南](../community/DEVELOPMENT.md)了解构建说明和开发工作流程。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0.0/introduction/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0.0/introduction/overview.md
index 11a0117912..929aa34ed4 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0.0/introduction/overview.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0.0/introduction/overview.md
@@ -4,11 +4,6 @@ title: 概述
sidebar_position: 1
---
-<div class="themed-logo">
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-dark.png"
class="themed-logo-dark"/>
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-light.png"
class="themed-logo-light"/>
-</div>
-
**Apache Fory™** 是一个高性能多语言序列化框架，面向原生对象序列化和跨语言二进制编解码，支持 Schema IDL、对象引用、Schema
演进、Row Format 随机访问与零拷贝读取。
Fory 面向跨语言、跨运行时的紧凑高吞吐序列化而构建。它可以直接处理应用中的对象；当需要稳定契约时，也可以使用共享
Schema；同时保留对象图中的共享引用、循环引用和多态运行时类型等语义。
@@ -105,84 +100,3 @@ Fory 让热点路径保持高速，同时不要求所有运行时采用相同实
- **生成式和静态序列化器**：其他运行时在合适场景下使用生成式或静态序列化器。
- **零拷贝路径**：行格式和带外 buffer 可避免大值的不必要复制。
- **元数据共享**：复用或打包重复类型信息，降低序列化开销。
-
-### 生产就绪
-
-企业级安全性和兼容性：
-
-- **类注册**：基于白名单的反序列化控制（默认启用）
-- **深度限制**：防止递归对象图攻击
-- **可配置策略**：自定义类检查器和反序列化策略
-- **平台支持**：Java 8-24、GraalVM 原生镜像、多操作系统平台
-
-## 协议
-
-Apache Fory™ 实现了针对不同场景优化的多个二进制协议：
-
-| 协议 | 使用场景
| 核心特性 |
-| ---------------------------------------------------------------- |
----------------- | --------------------------------- |
-| **[跨语言序列化](../specification/xlang_serialization_spec.md)** | 跨语言对象交换 |
自动序列化、引用、多态 |
-| **[Java 序列化](../specification/java_serialization_spec.md)** | 高性能 Java 专用
| Java 原生对象图、JDK 钩子、优化运行时 |
-| **[行格式](../specification/row_format_spec.md)** | 分析和数据处理 |
零拷贝随机访问、Arrow 兼容 |
-| **Python 原生** | Python
专用序列化 | Pickle/cloudpickle 替代，性能更好 |
-
-所有协议共享相同的优化代码库，一个协议的改进可以惠及其他协议。
-
-## 文档
-
-### 用户指南
-
-| 指南 | 描述 | 源文件
| 网站
|
-| ---------------- | ----------------------- |
-------------------------------------------------------------------------------------
| -------------------------------------- |
-| **Java 序列化** | Java 序列化综合指南 | [Java
指南](https://github.com/apache/fory/blob/main/docs/guide/java/) |
[查看](../guide/java) |
-| **跨语言序列化** | 多语言对象交换 | [Xlang
指南](https://github.com/apache/fory/blob/main/docs/guide/xlang/) |
[查看](../guide/xlang) |
-| **行格式** | 零拷贝随机访问格式 | [Java
行格式](https://github.com/apache/fory/blob/main/docs/guide/java/row-format.md) |
[查看](../guide/java/row-format.md) |
-| **Python** | Python 特定功能和用法 | [Python
指南](https://github.com/apache/fory/blob/main/docs/guide/python/) |
[查看](../guide/python) |
-| **Rust** | Rust 实现和模式 | [Rust
指南](https://github.com/apache/fory/blob/main/docs/guide/rust/) |
[查看](../guide/rust) |
-| **Go** | Go 实现和用法 | [Go
指南](https://github.com/apache/fory/blob/main/docs/guide/go/)
| [查看](../guide/go) |
-| **Scala** | Scala 集成和最佳实践 | [Scala
指南](https://github.com/apache/fory/blob/main/docs/guide/scala/) |
[查看](../guide/scala) |
-| **GraalVM** | 原生镜像支持和 AOT 编译 | [GraalVM
支持](https://github.com/apache/fory/blob/main/docs/guide/java/graalvm-support.md)
| [查看](../guide/java/graalvm_support) |
-| **开发** | 构建和贡献 Fory |
[开发指南](https://github.com/apache/fory/blob/main/docs/DEVELOPMENT.md)
| [查看](../community/DEVELOPMENT.md) |
-
-### 协议规范
-
-| 规范 | 描述 | 源文件
| 网站
|
-| ---------------- | ------------------ |
----------------------------------------------------------------------------------------------------------------------
| ------------------------------------------------------- |
-| **跨语言序列化** | 跨语言二进制协议 |
[xlang_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_serialization_spec.md)
| [查看](../specification/xlang_serialization_spec.md) |
-| **Java 序列化** | Java 优化协议 |
[java_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/java_serialization_spec.md)
| [查看](../specification/java_serialization_spec.md) |
-| **行格式** | 基于行的二进制格式 |
[row_format_spec.md](https://github.com/apache/fory/blob/main/docs/specification/row_format_spec.md)
| [查看](../specification/row_format_spec.md) |
-| **类型映射** | 跨语言类型转换 |
[xlang_type_mapping.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_type_mapping.md)
| [查看](../specification/xlang_type_mapping.md) |
-
-## 兼容性
-
-### Schema 兼容性
-
-Apache Fory™ 支持 **Java、Python、Rust 和 Golang** 的类 Schema 向前/向后兼容，支持生产系统中的无缝
Schema 演进，无需跨所有服务协调升级。Fory 提供两种 Schema 兼容性模式：
-
-1. **Schema 一致模式（默认）**：假设序列化和反序列化端之间的类 Schema
相同。此模式提供最小的序列化开销、最小的数据大小和最快的性能：适用于稳定的 Schema 或受控环境。
-
-2. **兼容模式**：支持独立的 Schema 演进，具有向前和向后兼容性。此模式支持字段添加/删除、有限的类型演进和优雅处理 Schema 不匹配。在
Java 中使用 `withCompatibleMode(CompatibleMode.COMPATIBLE)` 启用，在 Python 中使用
`compatible=True`，在 Rust 中使用 `compatible_mode(true)`，在 Go 中使用 `NewFory(true)`。
-
-## 社区与支持
-
-### 获取帮助
-
-- **Slack**：加入我们的 [Slack
工作区](https://join.slack.com/t/fory-project/shared_invite/zt-36g0qouzm-kcQSvV_dtfbtBKHRwT5gsw)参与社区讨论
-- **Twitter/X**：关注 [@ApacheFory](https://x.com/ApacheFory) 获取更新和公告
-- **GitHub Issues**：在 [apache/fory](https://github.com/apache/fory/issues)
报告错误和请求功能
-- **邮件列表**：订阅 Apache Fory 邮件列表参与开发讨论
-
-### 贡献
-
-我们欢迎贡献！请阅读我们的[贡献指南](https://github.com/apache/fory/blob/main/CONTRIBUTING.md)开始。
-
-**贡献方式**：
-
-- 报告错误和问题
-- 提出新功能
-- 改进文档
-- 提交 Pull Request
-- 添加测试用例
-- 分享基准测试
-
-详见[开发指南](../community/DEVELOPMENT.md)了解构建说明和开发工作流程。
diff --git a/sidebars.ts b/sidebars.ts
index 5f1ce56e68..d486f644df 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -17,7 +17,6 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'Introduction',
- link: {type: 'doc', id: 'introduction/overview'},
items: [{type: 'autogenerated', dirName: 'introduction'}],
collapsed: false,
},
diff --git a/src/css/custom.css b/src/css/custom.css
index d5ee709dec..30dec7e27a 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -30,16 +30,27 @@
}
.navbar__logo {
- height: 2.5rem;
+ height: 2.25rem;
+}
+
+@media (min-width: 997px) {
+ .navbar {
+ padding-left: calc(
+ var(--fory-doc-sidebar-inset) +
+ var(--ifm-menu-link-padding-horizontal)
+ );
+ }
}
.navbar__item {
- font-size: 1rem;
- margin-right: -10px;
+ font-size: .95rem;
+ margin-right: 0;
}
.navbar__link {
- font-size: 1rem;
+ font-size: .95rem;
+ padding-left: .55rem;
+ padding-right: .55rem;
}
@@ -82,4 +93,166 @@
[data-theme='dark'] .themed-logo-dark {
display: block;
-}
\ No newline at end of file
+}
+
+/* Docs reading surface */
+:root {
+ --fory-doc-content-width: 860px;
+ --fory-doc-shell-width: 908px;
+ --fory-doc-wide-width: 860px;
+ --fory-doc-gutter-width: 24px;
+ --fory-doc-sidebar-inset: 2.75rem;
+ --fory-doc-toc-right-inset: 5.5rem;
+}
+
+.theme-doc-breadcrumbs,
+.theme-doc-footer,
+.pagination-nav {
+ max-width: var(--fory-doc-content-width);
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.theme-doc-version-badge {
+ display: inline-block;
+ margin-left: max(0px, calc((100% - var(--fory-doc-shell-width)) / 2 +
var(--fory-doc-gutter-width)));
+}
+
+.theme-doc-markdown {
+ max-width: var(--fory-doc-shell-width);
+ margin-left: auto;
+ margin-right: auto;
+ font-size: 1.03rem;
+ line-height: 1.72;
+}
+
+.theme-doc-markdown > * {
+ max-width: var(--fory-doc-content-width);
+}
+
+.theme-doc-markdown > h1,
+.theme-doc-markdown > h2,
+.theme-doc-markdown > h3,
+.theme-doc-markdown > h4,
+.theme-doc-markdown > h5,
+.theme-doc-markdown > h6,
+.theme-doc-markdown > p,
+.theme-doc-markdown > header,
+.theme-doc-markdown > ul,
+.theme-doc-markdown > ol,
+.theme-doc-markdown > blockquote,
+.theme-doc-markdown > table,
+.theme-doc-markdown > div,
+.theme-doc-markdown > pre,
+.theme-doc-markdown > .tabs-container,
+.theme-doc-markdown > .theme-code-block,
+.theme-doc-markdown > .admonition {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.theme-doc-markdown > table {
+ display: table;
+}
+
+.theme-doc-markdown > pre,
+.theme-doc-markdown > table,
+.theme-doc-markdown > .tabs-container,
+.theme-doc-markdown > .theme-code-block {
+ max-width: var(--fory-doc-wide-width);
+}
+
+@media (min-width: 997px) {
+ .theme-doc-breadcrumbs,
+ .theme-doc-footer,
+ .pagination-nav,
+ .theme-doc-markdown {
+ padding-left: 1.5rem;
+ padding-right: 1.5rem;
+ }
+
+ .theme-doc-toc-desktop {
+ padding-right: var(--fory-doc-toc-right-inset);
+ }
+}
+
+.theme-doc-markdown h1 {
+ font-size: 2.6rem;
+ line-height: 1.1;
+ margin-bottom: 1.25rem;
+}
+
+.theme-doc-markdown h2 {
+ font-size: 1.8rem;
+ margin-top: 3rem;
+}
+
+.theme-doc-markdown h3 {
+ font-size: 1.35rem;
+ margin-top: 2.25rem;
+}
+
+.theme-doc-markdown p,
+.theme-doc-markdown li {
+ color: var(--ifm-color-emphasis-800);
+}
+
+.theme-doc-markdown table {
+ font-size: .95rem;
+}
+
+.theme-doc-markdown th {
+ background: var(--ifm-color-emphasis-100);
+}
+
+.theme-doc-markdown .theme-code-block,
+.theme-doc-markdown pre {
+ margin-top: 1rem;
+ margin-bottom: 1.75rem;
+}
+
+.table-of-contents {
+ font-size: .9rem;
+ line-height: 1.55;
+}
+
+.table-of-contents__link {
+ color: var(--ifm-color-emphasis-700);
+}
+
+.table-of-contents__link--active {
+ color: var(--ifm-color-primary);
+ font-weight: 600;
+}
+
+.theme-doc-sidebar-container {
+ background: var(--ifm-background-surface-color);
+}
+
+.theme-doc-sidebar-menu {
+ padding: .75rem .75rem .75rem var(--fory-doc-sidebar-inset);
+}
+
+.menu__link {
+ border-radius: 6px;
+ font-size: .96rem;
+}
+
+.menu__link--active {
+ font-weight: 600;
+}
+
+.theme-doc-sidebar-menu .menu__caret::before,
+.theme-doc-sidebar-menu .menu__link--sublist-caret::after {
+ background: var(--ifm-menu-link-sublist-icon) 50% / 1rem 1rem no-repeat;
+ height: .9rem;
+ min-width: .9rem;
+ opacity: .72;
+ width: .9rem;
+}
+
+@media (max-width: 996px) {
+ .theme-doc-markdown h1 {
+ font-size: 2.15rem;
+ }
+}
diff --git a/versioned_docs/version-1.0.0/introduction/overview.md
b/versioned_docs/version-1.0.0/introduction/overview.md
index f33d9dd582..d72dbc04ec 100644
--- a/versioned_docs/version-1.0.0/introduction/overview.md
+++ b/versioned_docs/version-1.0.0/introduction/overview.md
@@ -4,11 +4,6 @@ title: Overview
sidebar_position: 1
---
-<div class="themed-logo">
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-dark.png"
class="themed-logo-dark"/>
- <img width="65%" alt="Apache Fory logo" src="/img/fory-logo-light.png"
class="themed-logo-light"/>
-</div>
-
**Apache Fory™** is a blazingly-fast multi-language serialization framework for
idiomatic domain objects, schema IDL, and cross-language data exchange.
@@ -113,84 +108,3 @@ Fory keeps hot paths fast without making every runtime use
the same implementati
- **Generated and static serializers**: Other runtimes use generated or static
serializers where appropriate.
- **Zero-copy paths**: Row format and out-of-band buffers avoid unnecessary
copies for large values.
- **Metadata sharing**: Repeated type information is shared or packed to
reduce serialization overhead.
-
-### Production-Readiness
-
-Enterprise-grade security and compatibility:
-
-- **Class Registration**: Whitelist-based deserialization control (enabled by
default)
-- **Depth Limiting**: Protection against recursive object graph attacks
-- **Configurable Policies**: Custom class checkers and deserialization policies
-- **Platform Support**: Java 8-24, GraalVM native image, multiple OS platforms
-
-## Protocols
-
-Apache Fory™ implements multiple binary protocols optimized for different
scenarios:
-
-| Protocol |
Use Case | Key Features
|
-| ----------------------------------------------------------------------- |
------------------------------ |
------------------------------------------------------ |
-| **[Xlang Serialization](../specification/xlang_serialization_spec.md)** |
Cross-language object exchange | Automatic serialization, references,
polymorphism |
-| **[Java Serialization](../specification/java_serialization_spec.md)** |
High-performance Java-only | Java-native object graphs, JDK hooks,
optimized runtime |
-| **[Row Format](../specification/row_format_spec.md)** |
Analytics and data processing | Zero-copy random access, Arrow compatibility
|
-| **Python Native** |
Python-specific serialization | Pickle/cloudpickle replacement with better
performance |
-
-All protocols share the same optimized codebase, allowing improvements in one
protocol to benefit others.
-
-## Documentation
-
-### User Guides
-
-| Guide | Description
| Source
| Website |
-| -------------------------------- |
------------------------------------------ |
-----------------------------------------------------------------------------------------
| -------------------------------------- |
-| **Java Serialization** | Comprehensive guide for Java
serialization | [Java
Guide](https://github.com/apache/fory/blob/main/docs/guide/java/)
| [View](../guide/java) |
-| **Cross-Language Serialization** | Multi-language object exchange
| [Xlang Guide](https://github.com/apache/fory/blob/main/docs/guide/xlang/)
| [View](../guide/xlang) |
-| **Row Format** | Zero-copy random access format
| [Java Row
Format](https://github.com/apache/fory/blob/main/docs/guide/java/row-format.md)
| [View](../guide/java/row-format.md) |
-| **Python** | Python-specific features and usage
| [Python Guide](https://github.com/apache/fory/blob/main/docs/guide/python/)
| [View](../guide/python) |
-| **Rust** | Rust implementation and patterns
| [Rust Guide](https://github.com/apache/fory/blob/main/docs/guide/rust/)
| [View](../guide/rust) |
-| **Go** | Go implementation and usage
| [Go Guide](https://github.com/apache/fory/blob/main/docs/guide/go/)
| [View](../guide/go) |
-| **Scala** | Scala integration and best practices
| [Scala Guide](https://github.com/apache/fory/blob/main/docs/guide/scala/)
| [View](../guide/scala) |
-| **GraalVM** | Native image support and AOT compilation
| [GraalVM
Support](https://github.com/apache/fory/blob/main/docs/guide/java/graalvm-support.md)
| [View](../guide/java/graalvm_support) |
-| **Development** | Building and contributing to Fory
| [Development](https://github.com/apache/fory/blob/main/docs/DEVELOPMENT.md)
| [View](../community/DEVELOPMENT.md) |
-
-### Protocol Specifications
-
-| Specification | Description | Source
| Website |
-| ----------------------- | ------------------------------ |
----------------------------------------------------------------------------------------------------------------------
| ------------------------------------------------------- |
-| **Xlang Serialization** | Cross-language binary protocol |
[xlang_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_serialization_spec.md)
| [View](../specification/xlang_serialization_spec.md) |
-| **Java Serialization** | Java-optimized protocol |
[java_serialization_spec.md](https://github.com/apache/fory/blob/main/docs/specification/java_serialization_spec.md)
| [View](../specification/java_serialization_spec.md) |
-| **Row Format** | Row-based binary format |
[row_format_spec.md](https://github.com/apache/fory/blob/main/docs/specification/row_format_spec.md)
| [View](../specification/row_format_spec.md) |
-| **Type Mapping** | Cross-language type conversion |
[xlang_type_mapping.md](https://github.com/apache/fory/blob/main/docs/specification/xlang_type_mapping.md)
| [View](../specification/xlang_type_mapping.md) |
-
-## Compatibility
-
-### Schema Compatibility
-
-Apache Fory™ supports class schema forward/backward compatibility across
**Java, Python, Rust, and Golang**, enabling seamless schema evolution in
production systems without requiring coordinated upgrades across all services.
Fory provides two schema compatibility modes:
-
-1. **Schema Consistent Mode (Default)**: Assumes identical class schemas
between serialization and deserialization peers. This mode offers minimal
serialization overhead, smallest data size, and fastest performance: ideal for
stable schemas or controlled environments.
-
-2. **Compatible Mode**: Supports independent schema evolution with forward and
backward compatibility. This mode enables field addition/deletion, limited type
evolution, and graceful handling of schema mismatches. Enable using
`withCompatibleMode(CompatibleMode.COMPATIBLE)` in Java, `compatible=True` in
Python, `compatible_mode(true)` in Rust, or `NewFory(true)` in Go.
-
-## Community and Support
-
-### Getting Help
-
-- **Slack**: Join our [Slack
workspace](https://join.slack.com/t/fory-project/shared_invite/zt-36g0qouzm-kcQSvV_dtfbtBKHRwT5gsw)
for community discussions
-- **Twitter/X**: Follow [@ApacheFory](https://x.com/ApacheFory) for updates
and announcements
-- **GitHub Issues**: Report bugs and request features at
[apache/fory](https://github.com/apache/fory/issues)
-- **Mailing Lists**: Subscribe to Apache Fory mailing lists for development
discussions
-
-### Contributing
-
-We welcome contributions! Please read our [Contributing
Guide](https://github.com/apache/fory/blob/main/CONTRIBUTING.md) to get started.
-
-**Ways to Contribute**:
-
-- Report bugs and issues
-- Propose new features
-- Improve documentation
-- Submit pull requests
-- Add test cases
-- Share benchmarks
-
-See [Development Guide](../community/DEVELOPMENT.md) for build instructions
and development workflow.
diff --git a/versioned_sidebars/version-1.0.0-sidebars.json
b/versioned_sidebars/version-1.0.0-sidebars.json
index ac42638f3b..da2589bd7c 100644
--- a/versioned_sidebars/version-1.0.0-sidebars.json
+++ b/versioned_sidebars/version-1.0.0-sidebars.json
@@ -3,10 +3,6 @@
{
"type": "category",
"label": "Introduction",
- "link": {
- "type": "doc",
- "id": "introduction/overview"
- },
"items": [
{
"type": "autogenerated",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
