Skip to content

docs(compiler): update fory compiler doc #3183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chaokunyang merged 2 commits into from
Jan 21, 2026
Merged

docs(compiler): update fory compiler doc #3183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
712dc35
update fory compiler doc
chaokunyang Jan 21, 2026
25d535e
update doc
chaokunyang Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/compiler/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"position": 3,
"label": "Schema IDL & Compiler"
"label": "Schema IDL & Compiler",
"collapsible": true,
"collapsed": true
}
10 changes: 5 additions & 5 deletions docs/compiler/compiler-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FDL Compiler Guide
sidebar_position: 4
id: fdl_compiler_guide
title: Compiler Guide
sidebar_position: 3
id: compiler_guide
license: |
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
Expand Down Expand Up @@ -138,7 +138,7 @@ When compiling FDL files with imports, the compiler searches for imported files

**Same-directory imports work automatically:**

```proto
```protobuf
// main.fdl
import "common.fdl"; // Found if common.fdl is in the same directory
```
Expand Down Expand Up @@ -541,7 +541,7 @@ When modifying schemas:
3. **Add new fields** - Use new field numbers
4. **Use `optional`** - For backward compatibility

```proto
```protobuf
message User [id=100] {
string id = 1;
string name = 2;
Expand Down
Loading
Loading