Skip to content

Commit 7dcaba0

Browse files
l2hyunwool2hyunwoo
authored
docs: update documents (#77)
1 parent 92cbd32 commit 7dcaba0

20 files changed

Lines changed: 667 additions & 50 deletions

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,5 @@ CLAUDE.md
7878
.claude/
7979
openspec/
8080
docs/
81+
!documentation/content/docs/
82+
!documentation/app/docs/

documentation/content/docs/api/composable-dsl/delay.mdx renamed to documentation/content/docs/api/jindong-compose/composable-dsl/delay.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: DSL function to pause the pattern without vibrating
55

66
# Delay
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong.dsl`
10+
</Callout>
11+
812
Pauses the pattern for the specified duration without vibrating.
913

1014
## Signature
@@ -150,6 +154,6 @@ Jindong(trigger) {
150154

151155
## See Also
152156

153-
- [Haptic](/docs/api/composable-dsl/haptic)
154-
- [Sequence](/docs/api/composable-dsl/sequence)
155-
- [Repeat](/docs/api/composable-dsl/repeat)
157+
- [Haptic](/docs/api/jindong-compose/composable-dsl/haptic)
158+
- [Sequence](/docs/api/jindong-compose/composable-dsl/sequence)
159+
- [Repeat](/docs/api/jindong-compose/composable-dsl/repeat)

documentation/content/docs/api/composable-dsl/haptic.mdx renamed to documentation/content/docs/api/jindong-compose/composable-dsl/haptic.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: DSL function to emit a vibration event
55

66
# Haptic
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong.dsl`
10+
</Callout>
11+
812
Emits a vibration event for the specified duration.
913

1014
## Signature
@@ -137,6 +141,6 @@ Jindong(trigger) {
137141

138142
## See Also
139143

140-
- [Delay](/docs/api/composable-dsl/delay)
141-
- [HapticIntensity](/docs/api/core/haptic-intensity)
142-
- [Repeat](/docs/api/composable-dsl/repeat)
144+
- [Delay](/docs/api/jindong-compose/composable-dsl/delay)
145+
- [HapticIntensity](/docs/api/jindong-core/haptic-intensity)
146+
- [Repeat](/docs/api/jindong-compose/composable-dsl/repeat)

documentation/content/docs/api/composable-dsl/meta.json renamed to documentation/content/docs/api/jindong-compose/composable-dsl/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"title": "DSL Primitives",
2+
"title": "Composable DSL",
33
"pages": [
44
"haptic",
55
"delay",

documentation/content/docs/api/composable-dsl/repeat-with-index.mdx renamed to documentation/content/docs/api/jindong-compose/composable-dsl/repeat-with-index.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: DSL function to repeat content N times with index access
55

66
# RepeatWithIndex
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong.dsl`
10+
</Callout>
11+
812
Repeats the content block N times, providing the iteration index to each repetition.
913

1014
## Signature
@@ -168,6 +172,6 @@ RepeatWithIndex(5) { i -> Haptic((50 + i * 10).ms) }
168172

169173
## See Also
170174

171-
- [Repeat](/docs/api/composable-dsl/repeat)
172-
- [HapticIntensity](/docs/api/core/haptic-intensity)
173-
- [Haptic](/docs/api/composable-dsl/haptic)
175+
- [Repeat](/docs/api/jindong-compose/composable-dsl/repeat)
176+
- [HapticIntensity](/docs/api/jindong-core/haptic-intensity)
177+
- [Haptic](/docs/api/jindong-compose/composable-dsl/haptic)

documentation/content/docs/api/composable-dsl/repeat.mdx renamed to documentation/content/docs/api/jindong-compose/composable-dsl/repeat.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: DSL function to repeat content N times
55

66
# Repeat
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong.dsl`
10+
</Callout>
11+
812
Repeats the content block a specified number of times.
913

1014
## Signature
@@ -169,6 +173,6 @@ RepeatWithIndex(5) { index ->
169173

170174
## See Also
171175

172-
- [RepeatWithIndex](/docs/api/composable-dsl/repeat-with-index)
173-
- [Sequence](/docs/api/composable-dsl/sequence)
174-
- [Haptic](/docs/api/composable-dsl/haptic)
176+
- [RepeatWithIndex](/docs/api/jindong-compose/composable-dsl/repeat-with-index)
177+
- [Sequence](/docs/api/jindong-compose/composable-dsl/sequence)
178+
- [Haptic](/docs/api/jindong-compose/composable-dsl/haptic)

documentation/content/docs/api/composable-dsl/sequence.mdx renamed to documentation/content/docs/api/jindong-compose/composable-dsl/sequence.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: DSL function to group events sequentially
55

66
# Sequence
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong.dsl`
10+
</Callout>
11+
812
Groups haptic events to run one after another.
913

1014
## Signature
@@ -166,6 +170,6 @@ Jindong(trigger) {
166170

167171
## See Also
168172

169-
- [Repeat](/docs/api/composable-dsl/repeat)
170-
- [RepeatWithIndex](/docs/api/composable-dsl/repeat-with-index)
171-
- [Haptic](/docs/api/composable-dsl/haptic)
173+
- [Repeat](/docs/api/jindong-compose/composable-dsl/repeat)
174+
- [RepeatWithIndex](/docs/api/jindong-compose/composable-dsl/repeat-with-index)
175+
- [Haptic](/docs/api/jindong-compose/composable-dsl/haptic)

documentation/content/docs/api/core/jindong-provider.mdx renamed to documentation/content/docs/api/jindong-compose/jindong-provider.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: Provider component that enables haptic feedback in the composition
55

66
# JindongProvider
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong`
10+
</Callout>
11+
812
Provider component that creates and provides a `HapticExecutor` to the composition tree.
913

1014
## Signature
@@ -142,5 +146,5 @@ No additional requirements. Core Haptics available on iOS 13+.
142146

143147
## See Also
144148

145-
- [Jindong](/docs/api/core/jindong)
149+
- [Jindong](/docs/api/jindong-compose/jindong)
146150
- [Getting Started](/docs/guide/getting-started)

documentation/content/docs/api/core/jindong-scope.mdx renamed to documentation/content/docs/api/jindong-compose/jindong-scope.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Functions available within `JindongScope`:
2727

2828
| Function | Description |
2929
|----------|-------------|
30-
| [`Haptic`](/docs/api/composable-dsl/haptic) | Emit a vibration event |
31-
| [`Delay`](/docs/api/composable-dsl/delay) | Pause the pattern |
32-
| [`Sequence`](/docs/api/composable-dsl/sequence) | Group events sequentially |
33-
| [`Repeat`](/docs/api/composable-dsl/repeat) | Repeat content N times |
34-
| [`RepeatWithIndex`](/docs/api/composable-dsl/repeat-with-index) | Repeat with index access |
30+
| [`Haptic`](/docs/api/jindong-compose/composable-dsl/haptic) | Emit a vibration event |
31+
| [`Delay`](/docs/api/jindong-compose/composable-dsl/delay) | Pause the pattern |
32+
| [`Sequence`](/docs/api/jindong-compose/composable-dsl/sequence) | Group events sequentially |
33+
| [`Repeat`](/docs/api/jindong-compose/composable-dsl/repeat) | Repeat content N times |
34+
| [`RepeatWithIndex`](/docs/api/jindong-compose/composable-dsl/repeat-with-index) | Repeat with index access |
3535

3636
## Usage
3737

@@ -140,5 +140,5 @@ The actual behavior comes from the DSL extension functions, not the scope interf
140140

141141
## See Also
142142

143-
- [Jindong](/docs/api/core/jindong)
143+
- [Jindong](/docs/api/jindong-compose/jindong)
144144
- [Composable DSL](/docs/api/composable-dsl)

documentation/content/docs/api/core/jindong.mdx renamed to documentation/content/docs/api/jindong-compose/jindong.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description: The main composable for defining and executing haptic patterns
55

66
# Jindong
77

8+
<Callout type="info">
9+
**Module**: `jindong-compose` | **Package**: `io.github.compose.jindong`
10+
</Callout>
11+
812
The main composable for defining haptic patterns with trigger-based execution.
913

1014
## Signature
@@ -160,11 +164,11 @@ Within the `JindongScope`, you can use:
160164

161165
| Function | Description |
162166
|----------|-------------|
163-
| [`Haptic`](/docs/api/composable-dsl/haptic) | Emit a vibration |
164-
| [`Delay`](/docs/api/composable-dsl/delay) | Pause the pattern |
165-
| [`Sequence`](/docs/api/composable-dsl/sequence) | Group events sequentially |
166-
| [`Repeat`](/docs/api/composable-dsl/repeat) | Repeat content N times |
167-
| [`RepeatWithIndex`](/docs/api/composable-dsl/repeat-with-index) | Repeat with index access |
167+
| [`Haptic`](/docs/api/jindong-compose/composable-dsl/haptic) | Emit a vibration |
168+
| [`Delay`](/docs/api/jindong-compose/composable-dsl/delay) | Pause the pattern |
169+
| [`Sequence`](/docs/api/jindong-compose/composable-dsl/sequence) | Group events sequentially |
170+
| [`Repeat`](/docs/api/jindong-compose/composable-dsl/repeat) | Repeat content N times |
171+
| [`RepeatWithIndex`](/docs/api/jindong-compose/composable-dsl/repeat-with-index) | Repeat with index access |
168172

169173
## Notes
170174

@@ -175,6 +179,6 @@ Within the `JindongScope`, you can use:
175179

176180
## See Also
177181

178-
- [JindongProvider](/docs/api/core/jindong-provider)
179-
- [JindongScope](/docs/api/core/jindong-scope)
182+
- [JindongProvider](/docs/api/jindong-compose/jindong-provider)
183+
- [JindongScope](/docs/api/jindong-compose/jindong-scope)
180184
- [Quick Start](/docs/guide/quick-start)

0 commit comments

Comments
 (0)