Skip to content

Commit 8b8aa28

Browse files
committed
fix(doc): make "iter" package visible in doc sidebar
1 parent 39e418f commit 8b8aa28

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ import (
6161
"github.com/samber/lo"
6262
lop "github.com/samber/lo/parallel"
6363
lom "github.com/samber/lo/mutable"
64+
loi "github.com/samber/lo/it"
6465
)
6566
```
6667

docs/docs/about.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import (
3939
"github.com/samber/lo"
4040
lop "github.com/samber/lo/parallel"
4141
lom "github.com/samber/lo/mutable"
42+
loi "github.com/samber/lo/it"
4243
)
4344
```
4445

docs/docs/getting-started.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ sidebar_position: 1
88

99
**samber/lo** is a Lodash-style utility library for Go 1.18+ that leverages generics to provide type-safe helper functions. The library is organized into several packages, each serving different use cases.
1010

11-
## Installation
11+
## 🚀 Install
1212

1313
```bash
1414
go get -u github.com/samber/lo@v1
1515
```
1616

17-
## Base Package (`lo`)
17+
## 🧢 Core Package (`lo`)
1818

1919
The main package provides immutable utility functions for slices, maps, strings, math operations, and more. It's the core of the library with over 300+ functions.
2020

@@ -29,26 +29,26 @@ squared := lo.Map(numbers, func(x int, _ int) int {
2929
// Result: [1, 4, 9, 16, 25]
3030
```
3131

32-
## Iter Package (`lo/it`)
32+
## 🔄 Iter Package (`lo/it`)
3333

3434
The `it` package provides Go 1.23+ sequence helpers with lazy evaluation, offering over 100 functions for efficient iteration without buffering.
3535

3636
```go
3737
// Future usage (Go 1.23+)
3838
import (
3939
"iter"
40-
loit "github.com/samber/lo/it"
40+
loi "github.com/samber/lo/it"
4141
)
4242

4343
seqIn := iter.Range(0, 1000)
4444

4545
// Lazy iteration without buffering
46-
seqOut := loit.Filter(seqIn, func(x int) bool {
46+
seqOut := loi.Filter(seqIn, func(x int) bool {
4747
return x%2 == 0
4848
})
4949
```
5050

51-
## Mutable Package (`lo/mutable`)
51+
## 👣 Mutable Package (`lo/mutable`)
5252

5353
The mutable package provides in-place operations that modify collections directly, useful for performance-critical scenarios.
5454

@@ -63,7 +63,7 @@ lom.Filter(&numbers, func(x int) bool {
6363
// Result: [2, 4]
6464
```
6565

66-
## Parallel Package (`lo/parallel`)
66+
## 🏎️ Parallel Package (`lo/parallel`)
6767

6868
The parallel package enables concurrent processing of collections with built-in worker pools, perfect for CPU-intensive operations.
6969

@@ -77,7 +77,7 @@ results := lop.Map(numbers, 4, func(x int) int {
7777
})
7878
```
7979

80-
## Key Benefits
80+
## Key Benefits
8181

8282
- **Type-safe** with generics
8383
- **Immutable** by default (main package)
@@ -86,7 +86,7 @@ results := lop.Map(numbers, 4, func(x int) int {
8686
- **Lazy evaluation** with `iter` std package (Go >= 1.23)
8787
- **Minimal dependencies** zero dependencies outside the Go standard library
8888

89-
## Next Steps
89+
## 👀 Next Steps
9090

9191
- Check the [Go documentation](https://pkg.go.dev/github.com/samber/lo) for complete API reference
9292
- Explore examples in the repository

docs/docs/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: glossary
33
title: 📚 Glossary
44
description: Comprehensive glossary of samber/lo library terms and concepts
5-
sidebar_position: 10
5+
sidebar_position: 100
66
---
77

88
# Glossary

docs/sidebars.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ const sidebars: SidebarsConfig = {
2626
{type: 'autogenerated', dirName: 'core'},
2727
],
2828
},
29-
// {
30-
// type: 'category',
31-
// label: '🔄 Iterator',
32-
// collapsible: true,
33-
// collapsed: true,
34-
// items: [
35-
// {type: 'autogenerated', dirName: 'iter'},
36-
// ],
37-
// },
29+
{
30+
type: 'category',
31+
label: '🔄 Iterator',
32+
collapsible: true,
33+
collapsed: true,
34+
items: [
35+
{type: 'autogenerated', dirName: 'iter'},
36+
],
37+
},
3838
{
3939
type: 'category',
4040
label: '👣 Mutable',

0 commit comments

Comments
 (0)