Skip to content

Commit 67ab589

Browse files
committed
Update library docs and navigation for Array section
Revised the library documentation to introduce the Array section as the first step in the learning path, updated descriptions for core concepts, and added the Array link to the navigation menu.
1 parent 98a4b6c commit 67ab589

2 files changed

Lines changed: 22 additions & 14 deletions

File tree

apps/web/src/app/(docs)/docs/library/page.mdx

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const metadata = {
66

77
# Get started with the library
88

9-
This guide will get you up and running with Evolu Library.
9+
This guide will help you get started with the Evolu Library.
1010

1111
<Note>
1212
Requirements: `TypeScript 5.7` or later with the `strict` flag enabled in
@@ -21,32 +21,36 @@ npm install @evolu/common
2121

2222
## Learning path
2323

24-
We recommend learning Evolu Library in this order:
24+
We recommend learning the Evolu Library in this order:
2525

26-
### 1. Result – Error handling
26+
### 1. Array
2727

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.
28+
Start with [`Array`](/docs/api-reference/common/Array), which provides helpers for improved type-safety and developer experience.
2929

30-
### 2. Task – Asynchronous operations
30+
### 2. Result
3131

32-
Learn [`Task`](/docs/api-reference/common/Task/interfaces/Task), which represents asynchronous computations in a lazy, composable way.
32+
Learn [`Result`](/docs/api-reference/common/Result/type-aliases/Result), a type-safe way to handle errors. It's the foundation for composable error handling.
3333

34-
### 3. Type – Runtime validation
34+
### 3. Task
3535

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.
36+
Continue with [`Task`](/docs/api-reference/common/Task/interfaces/Task) for structured concurrency (promises that can be aborted, monitored, and do not leak).
3737

38-
### 4. Dependency injection
38+
### 4. Type
3939

40-
Explore the [dependency injection pattern](/docs/dependency-injection) used throughout Evolu for decoupled, testable code.
40+
Check the [`Type`](/docs/api-reference/common/Type) to enforce constraints at compile-time and validate data at runtime.
4141

42-
### 5. Resource management
42+
### 5. Dependency injection
4343

44-
Learn [resource management](/docs/resource-management) with `using`, `DisposableStack`, and how it integrates with `Result` for reliable cleanup.
44+
Explore [dependency injection](/docs/dependency-injection), the pattern Evolu uses to swap implementations and simplify testing.
4545

46-
### 6. Conventions
46+
### 6. Resource management
47+
48+
See [resource management](/docs/resource-management)`using`, `DisposableStack`, and how it integrates with `Result` for reliable cleanup.
49+
50+
### 7. Conventions
4751

4852
Review the [Evolu conventions](/docs/conventions) to understand the codebase style and patterns.
4953

5054
## Exploring the API
5155

52-
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.
56+
After understanding the core concepts, explore the full API in the [API reference](/docs/api-reference/common). All code is commented, and tests are written to be read as examples—they demonstrate practical usage patterns and edge cases.

apps/web/src/lib/navigation.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ export const navigation: Array<NavGroup> = [
1515
title: "Library",
1616
links: [
1717
{ title: "Getting started", href: "/docs/library" },
18+
{
19+
title: "Array",
20+
href: "/docs/api-reference/common/Array",
21+
},
1822
{
1923
title: "Result",
2024
href: "/docs/api-reference/common/Result/type-aliases/Result",

0 commit comments

Comments
 (0)