docs: update guide and compiler docs#3298
Merged
chaokunyang merged 10 commits intoapache:mainfrom Feb 6, 2026
Merged
Conversation
theweipeng
approved these changes
Feb 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The docs were out of sync with current APIs and naming in several places (especially xlang examples and compiler/IDL terminology), and benchmark links/path layout were inconsistent.
What does this PR do?
docs/benchmarks/java/and updates references in top-level docs (README.md,docs/README.md, andjava/README.md).docs/compiler/index.md,compiler-guide.md,schema-idl.md,protobuf-idl.md,flatbuffers-idl.md,generated-code.md) to better present Fory IDL concepts, workflows, and generated code guidance.Related issues
#1017
Does this PR introduce any user-facing change?
Documentation-only user-facing changes (guides, examples, and doc structure).
Benchmark
N/A (documentation-only changes).