Skip to content

Commit f019fda

Browse files
committed
update website
1 parent a45a271 commit f019fda

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+2838
-10303
lines changed

website/docs/compiler/field-guide/00-welcome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ By the end of your first day, you should be able to:
1414

1515
You’ll learn Ora by looking at what it produces:
1616

17-
**Tokens → AST → Typed AST → Ora MLIR → (verification & passes) → SIR**
17+
**Tokens → AST → Typed AST → Ora MLIR → (verification & passes) → Sensei-IR (SIR)**
1818

1919
This ladder is your map for both development and debugging.
2020

website/docs/compiler/field-guide/02-compiler-shape.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ Think of each phase as a team member with a job and a promise:
4141
- **Output:** verified, optimized IR; optionally SMT results
4242
- **Promise:** invalid programs are rejected early; valid programs are normalized for the backend
4343

44-
### Ora → SIR conversion
44+
### Ora → Sensei-IR (SIR) conversion
4545
- **Input:** Ora MLIR
46-
- **Output:** SIR MLIR
47-
- **Promise:** whatever reaches SIR is in the “legal” subset supported by the backend
46+
- **Output:** Sensei-IR (SIR) MLIR
47+
- **Promise:** whatever reaches Sensei-IR (SIR) is in the “legal” subset supported by the backend
4848

4949
## 2.2 The one design choice to remember: typed AST
5050

@@ -58,7 +58,7 @@ That means:
5858
## 2.3 Where to stand when you’re confused
5959

6060
If you feel lost:
61-
- go back to the artifact ladder (Tokens → AST → Typed AST → MLIR → SIR)
61+
- go back to the artifact ladder (Tokens → AST → Typed AST → MLIR → Sensei-IR (SIR))
6262
- run the phase you think is failing in isolation
6363
- inspect the artifact
6464

website/docs/compiler/field-guide/04-walkthrough.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Type resolution answers:
4949
- what is the type of `value + delta`? (u256)
5050
- is `requires(delta > 0)` valid? (a boolean constraint)
5151

52-
This is where many important rules live, including rules around error unions and `try`.
52+
Many important rules live here, including rules around error unions and `try`.
5353

5454
## 4.5 MLIR: the program becomes explicit operations
5555

website/docs/compiler/field-guide/04b-failing-walkthrough.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Now re-run:
6565
- MLIR won’t be produced because the AST isn’t structurally valid.
6666

6767
### Conclusion (phase-local)
68-
**This is a parser/grammar/recovery issue**.
68+
**Parser/grammar/recovery issue**.
6969

7070
### Where fixes usually live
7171
- parser modules (`src/parser/*`)
@@ -79,7 +79,7 @@ Now re-run:
7979

8080
## Failure 2 — Type resolution failure (structure is fine, meaning is wrong)
8181

82-
Here we create a program that parses cleanly, but violates a typing rule. This is the most common onboarding confusion: “It parses, why doesn’t it compile?”
82+
Here we create a program that parses cleanly, but violates a typing rule. Most common onboarding confusion: “It parses, why doesn’t it compile?”
8383

8484
### Step 1: Create a file that uses an error union
8585

@@ -122,7 +122,7 @@ contract SafeMath {
122122
In Ora, error unions must be **unwrapped** (typically with `try`) before you can use the success value.
123123

124124
### Conclusion (phase-local)
125-
**This is a typing rule issue (type resolver), not a parser issue.**
125+
**Typing rule issue (type resolver), not a parser issue.**
126126

127127
### Where fixes usually live
128128
- type resolver rules (`src/ast/type_resolver/*`)
@@ -182,7 +182,7 @@ Now, **change the body** to include the specific feature you’re working on (or
182182
- or it emits an obviously incomplete/empty region for the construct
183183

184184
### Conclusion (phase-local)
185-
**This is a lowering coverage issue**.
185+
**Lowering coverage issue**.
186186

187187
### Where fixes usually live
188188
- `src/mlir/lower.zig`

website/docs/compiler/field-guide/05-core-systems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Key locations:
9292
Responsibilities:
9393
- verify dialect invariants
9494
- canonicalize/optimize
95-
- convert Ora → SIR as a legality boundary
95+
- convert Ora → Sensei-IR (SIR) as a legality boundary
9696
- optionally run SMT verification passes
9797

9898
Key locations:

website/docs/compiler/field-guide/06-debugging-playbook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ When a user reports “the compiler is broken”, you do this:
2525
- typed fields wrong / type errors → type resolver / semantics
2626
- MLIR wrong → lowering
2727
- verifier complains → MLIR verifier / legality / passes
28-
- conversion fails → Ora → SIR patterns
28+
- conversion fails → Ora → Sensei-IR (SIR) patterns
2929
- Z3 fails → encoder/constraints
3030

3131
---
@@ -65,7 +65,7 @@ When a user reports “the compiler is broken”, you do this:
6565
- the lowering is producing an illegal op shape, or
6666
- the verifier is missing/too strict for the intended feature
6767

68-
### Symptom: Ora → SIR conversion fails
68+
### Symptom: Ora → Sensei-IR (SIR) conversion fails
6969
**Likely area:** missing conversion pattern(s)
7070
**Fix style:** add a conversion pattern and a test that fails before and passes after.
7171

website/docs/compiler/field-guide/07-first-compiler-pr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Your First Compiler PR (guided "safe" changes)
22

3-
This chapter gives you three starter PRs. Each PR is designed to be:
3+
This chapter gives you three starter PRs. Each PR is scoped to be:
44
- small enough to finish
55
- valuable even if you’re new
66
- easy to review
@@ -42,7 +42,7 @@ Pick one lowering error and add:
4242

4343
## PR 3 — Add one missing conversion pattern (Lane B starter)
4444

45-
**Goal:** fix a concrete “Ora → SIR conversion failed” issue.
45+
**Goal:** fix a concrete “Ora → Sensei-IR (SIR) conversion failed” issue.
4646

4747
### What to do
4848
1) find the illegal or unsupported op in the emitted MLIR

website/docs/compiler/field-guide/08-advanced.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ This chapter is for when you’re adding real language features and need end-to-
1111
In Ora, “legal” in practice means:
1212
1) the Ora MLIR is structurally valid and passes dialect verification
1313
2) the program survives passes/canonicalization without breaking invariants
14-
3) the IR can be converted to SIR (the backend-supported subset)
14+
3) the IR can be converted to Sensei-IR (SIR) (the backend-supported subset)
1515

1616
A useful mental model:
17-
- **Ora → SIR conversion is a hard boundary.**
18-
- If a feature reaches SIR, it is in a subset the backend knows how to handle.
17+
- **Ora → Sensei-IR (SIR) conversion is a hard boundary.**
18+
- If a feature reaches Sensei-IR (SIR), it is in a subset the backend knows how to handle.
1919

2020
## 8.2 Passes and canonicalization
2121

website/docs/compiler/field-guide/appendix-a-glossary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Appendix A — Glossary
22

3-
**Artifact ladder** — Tokens → AST → Typed AST → MLIR → SIR.
3+
**Artifact ladder** — Tokens → AST → Typed AST → MLIR → Sensei-IR (SIR).
44

55
**AST** — Abstract Syntax Tree. The structured representation of the program produced by the parser.
66

@@ -16,9 +16,9 @@
1616

1717
**Dialect verification** — Structural invariants checked on IR (distinct from SMT verification).
1818

19-
**Legality** — Whether an op/program shape is supported and convertible (in practice, whether it can be converted to SIR).
19+
**Legality** — Whether an op/program shape is supported and convertible (in practice, whether it can be converted to Sensei-IR (SIR)).
2020

21-
**Ora → SIR conversion** — Lowering pass that converts Ora IR to SIR IR (backend subset).
21+
**Ora → Sensei-IR (SIR) conversion** — Lowering pass that converts Ora IR to Sensei-IR (SIR) IR (backend subset).
2222

2323
**SMT verification** — Constraint solving using a solver (e.g., Z3) to validate requires/ensures/invariants.
2424

website/docs/compiler/field-guide/appendix-b-codebase-map.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Appendix B — Codebase Map (quick reference)
22

3-
This is a navigation aid. If you’re unsure where something lives, start here.
3+
Navigation aid. If you’re unsure where something lives, start here.
44

55
## CLI / Orchestration
66
- `src/main.zig`
@@ -19,7 +19,7 @@ This is a navigation aid. If you’re unsure where something lives, start here.
1919
- MLIR modules: `src/mlir/*`
2020
- Verification: `src/mlir/verification.zig`
2121
- Pass pipeline: `src/mlir/pass_manager.zig`
22-
- Ora → SIR conversion patterns: `src/mlir/ora/lowering/OraToSIR/*`
22+
- Ora → Sensei-IR (SIR) conversion patterns: `src/mlir/ora/lowering/OraToSIR/*`
2323

2424
## SMT / Z3
2525
- Z3 integration: `src/z3/*` (notably `encoder.zig`)

0 commit comments

Comments
 (0)