Skip to content

Commit

Permalink
[DOC] doc sync stay consistent with the site (#1266)
Browse files Browse the repository at this point in the history
The structure and frontmatter of the site has some changes, so it is
necessary to ensure that the results synced over remain consistent

Co-authored-by: theweipeng <[email protected]>
  • Loading branch information
theweipeng authored Dec 27, 2023
1 parent a8f081b commit ae1fe20
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ apache/incubator-fury-site@main:
- source: docs/guide/
dest: docs/guide/
- source: docs/benchmarks/
dest: public/benchmarks/
dest: static/img/benchmarks/
3 changes: 2 additions & 1 deletion docs/guide/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- fury_frontmatter --
title: Development
order: 6
sidebar_position: 6
id: development
-- fury_frontmatter -->
# How to build to Fury

Expand Down
5 changes: 3 additions & 2 deletions docs/guide/graalvm_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- fury_frontmatter --
title: GraalVM Guide
order: 6
sidebar_position: 6
id: graalvm_guide
-- fury_frontmatter -->

# GraalVM Native Image
Expand Down Expand Up @@ -130,7 +131,7 @@ When Fury compression is enabled:
- Struct: Fury is `24x speed, 31% size` compared to JDK.
- Pojo: Fury is `12x speed, 48% size` compared to JDK.

See [[Benchmark.java](../../integration_tests/graalvm_tests/src/main/java/org/apache/fury/graalvm/Benchmark.java)] for benchmark code.
See [[Benchmark.java](https://github.com/apache/incubator-fury/blob/main/integration_tests/graalvm_tests/src/main/java/org/apache/fury/graalvm/Benchmark.java)] for benchmark code.

### Struct Benchmark
#### Class Fields
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/java_object_graph_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- fury_frontmatter --
title: Java Object Graph Guide
order: 0
sidebar_position: 0
id: java_object_graph_guide
-- fury_frontmatter -->

# Java object graph serialization
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/row_format_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- fury_frontmatter --
title: Row Format Guide
order: 1
sidebar_position: 1
id: row_format_guide
-- fury_frontmatter -->

## Row format protocol
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/scala_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- fury_frontmatter --
title: Scala Serialization Guide
order: 4
sidebar_position: 4
id: scala_guide
-- fury_frontmatter -->

# Scala serialization
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/xlang_object_graph_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- fury_frontmatter --
title: Xlang Object Graph Guide
order: 2
sidebar_position: 2
id: xlang_object_graph_guide
-- fury_frontmatter -->

## Cross-language object graph serialization
Expand Down

0 comments on commit ae1fe20

Please sign in to comment.