You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/web/src/app/(docs)/docs/library/page.mdx
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,3 +18,31 @@ This guide will get you up and running with Evolu Library.
18
18
```bash
19
19
npm install @evolu/common
20
20
```
21
+
22
+
## Learning path
23
+
24
+
We recommend learning Evolu Library in this order:
25
+
26
+
### 1. Result – Error handling
27
+
28
+
Start with [`Result`](/docs/api-reference/common/Result/type-aliases/Result), which provides a type-safe way to handle errors without exceptions. It's the foundation for composable error handling throughout Evolu.
29
+
30
+
### 2. Task – Asynchronous operations
31
+
32
+
Learn [`Task`](/docs/api-reference/common/Task/interfaces/Task), which represents asynchronous computations in a lazy, composable way.
33
+
34
+
### 3. Type – Runtime validation
35
+
36
+
Understand the [`Type`](/docs/api-reference/common/Type) system for runtime validation and parsing. This enables you to enforce constraints at compile-time and validate untrusted data at runtime.
37
+
38
+
### 4. Dependency injection
39
+
40
+
Explore the [dependency injection pattern](/docs/dependency-injection) used throughout Evolu for decoupled, testable code.
41
+
42
+
### 5. Conventions
43
+
44
+
Review the [Evolu conventions](/docs/conventions) to understand the codebase style and patterns.
45
+
46
+
## Exploring the API
47
+
48
+
After understanding the core concepts, explore the full API in the [API reference](/docs/api-reference/common). All code is commented and test files are written to be read as examples—they demonstrate practical usage patterns and edge cases.
0 commit comments