Skip to content

Commit 0bb80ef

Browse files
saseungminsaseungmin
authored
docs(rspress): update docs config and add versioned AI guide (#153)
1 parent 9e78690 commit 0bb80ef

12 files changed

Lines changed: 458 additions & 361 deletions

File tree

β€Ž.changeset/large-moles-juggle.mdβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'react-native-gesture-image-viewer': patch
3+
---
4+
5+
docs(rspress): update docs config and add versioned AI guide
6+
7+
Update the Rspress docs setup and add versioned AI guide pages for both 1.x and 2.x documentation. This includes guidance for using llms.txt, llms-full.txt, and Markdown doc links with AI tools, and adjusts the docs build config to avoid the experimental worker build issue after the Rspress upgrade.

β€Ždocs/docs/1.x/en/guide/getting-started/_meta.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["overview", "installation", "quick-start"]
1+
["overview", "installation", "quick-start", "ai"]

β€Ždocs/docs/1.x/en/guide/getting-started/ai.mdxβ€Ž

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AI
2+
3+
To help AI better understand this library's `1.x` behavior, documentation, and project conventions so it can provide more accurate help during development and troubleshooting, this project provides the following capabilities:
4+
5+
## llms.txt
6+
7+
[`llms.txt`](https://llmstxt.org/) helps LLMs discover and use project documentation. For `1.x`, use the following files.
8+
9+
- [1.x/llms.txt](https://react-native-gesture-image-viewer.pages.dev/1.x/llms.txt): The structured index file for the `1.x` docs.
10+
11+
```txt
12+
https://react-native-gesture-image-viewer.pages.dev/1.x/llms.txt
13+
```
14+
15+
- [1.x/llms-full.txt](https://react-native-gesture-image-viewer.pages.dev/1.x/llms-full.txt): The full-content file that concatenates the complete `1.x` documentation into a single file.
16+
17+
```txt
18+
https://react-native-gesture-image-viewer.pages.dev/1.x/llms-full.txt
19+
```
20+
21+
## Markdown docs
22+
23+
Every documentation page also has a corresponding Markdown version that can be passed directly to AI.
24+
25+
Examples:
26+
27+
```txt
28+
https://react-native-gesture-image-viewer.pages.dev/1.x/guide/getting-started/overview.md
29+
https://react-native-gesture-image-viewer.pages.dev/1.x/guide/getting-started/quick-start.md
30+
https://react-native-gesture-image-viewer.pages.dev/1.x/guide/usage/programmatic-control.md
31+
```
32+
33+
Providing a single Markdown page is often the most efficient option when you want help with one specific feature.

β€Ždocs/docs/1.x/ko/guide/getting-started/_meta.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["overview", "installation", "quick-start"]
1+
["overview", "installation", "quick-start", "ai"]

β€Ždocs/docs/1.x/ko/guide/getting-started/ai.mdxβ€Ž

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AI
2+
3+
AIκ°€ 이 라이브러리의 `1.x` λ™μž‘, λ¬Έμ„œ, ν”„λ‘œμ νŠΈ κ·œμΉ™μ„ 더 잘 μ΄ν•΄ν•΄μ„œ κ°œλ°œμ΄λ‚˜ νŠΈλŸ¬λΈ”μŠˆνŒ… κ³Όμ •μ—μ„œ 더 μ •ν™•ν•œ 도움을 쀄 수 μžˆλ„λ‘, 이 ν”„λ‘œμ νŠΈλŠ” λ‹€μŒ κΈ°λŠ₯듀을 μ œκ³΅ν•©λ‹ˆλ‹€.
4+
5+
## llms.txt
6+
7+
[`llms.txt`](https://llmstxt.org/)λŠ” LLM이 ν”„λ‘œμ νŠΈ λ¬Έμ„œλ₯Ό 더 μ‰½κ²Œ νƒμƒ‰ν•˜κ³  ν™œμš©ν•  수 μžˆλ„λ‘ λ•λŠ” ν‘œμ€€μž…λ‹ˆλ‹€. `1.x` λ¬Έμ„œλŠ” μ•„λž˜ νŒŒμΌμ„ μ‚¬μš©ν•˜λ©΄ λ©λ‹ˆλ‹€.
8+
9+
- [1.x/llms.txt](https://react-native-gesture-image-viewer.pages.dev/1.x/llms.txt): `1.x` λ¬Έμ„œμš© κ΅¬μ‘°ν™”λœ 인덱슀 파일
10+
11+
```txt
12+
https://react-native-gesture-image-viewer.pages.dev/1.x/llms.txt
13+
```
14+
15+
- [1.x/llms-full.txt](https://react-native-gesture-image-viewer.pages.dev/1.x/llms-full.txt): `1.x` λ¬Έμ„œ 전체λ₯Ό ν•˜λ‚˜λ‘œ ν•©μΉœ 파일
16+
17+
```txt
18+
https://react-native-gesture-image-viewer.pages.dev/1.x/llms-full.txt
19+
```
20+
21+
## Markdown docs
22+
23+
λͺ¨λ“  λ¬Έμ„œ νŽ˜μ΄μ§€λŠ” AIμ—κ²Œ 직접 전달할 수 μžˆλŠ” Markdown 버전도 ν•¨κ»˜ μ œκ³΅ν•©λ‹ˆλ‹€.
24+
25+
μ˜ˆμ‹œ:
26+
27+
```txt
28+
https://react-native-gesture-image-viewer.pages.dev/1.x/guide/getting-started/overview.md
29+
https://react-native-gesture-image-viewer.pages.dev/1.x/guide/getting-started/quick-start.md
30+
https://react-native-gesture-image-viewer.pages.dev/1.x/guide/usage/programmatic-control.md
31+
```
32+
33+
νŠΉμ • κΈ°λŠ₯만 λ¬Όμ–΄λ³Ό λ•ŒλŠ” 전체 λ¬Έμ„œλ³΄λ‹€ κ΄€λ ¨ Markdown νŽ˜μ΄μ§€ ν•˜λ‚˜λ₯Ό μ œκ³΅ν•˜λŠ” 편이 더 νš¨μœ¨μ μž…λ‹ˆλ‹€.

β€Ždocs/docs/2.x/en/guide/getting-started/_meta.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["overview", "installation", "quick-start"]
1+
["overview", "installation", "quick-start", "ai"]

β€Ždocs/docs/2.x/en/guide/getting-started/ai.mdxβ€Ž

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# AI
2+
3+
To help AI better understand this library's features, versioned documentation, and project conventions so it can provide more accurate help during development and troubleshooting, this project provides the following capabilities:
4+
5+
## llms.txt
6+
7+
[`llms.txt`](https://llmstxt.org/) helps LLMs discover and use project documentation. This site publishes the following files.
8+
9+
- [llms.txt](https://react-native-gesture-image-viewer.pages.dev/llms.txt): The structured index file for the current `2.x` docs.
10+
11+
```txt
12+
https://react-native-gesture-image-viewer.pages.dev/llms.txt
13+
```
14+
15+
- [llms-full.txt](https://react-native-gesture-image-viewer.pages.dev/llms-full.txt): The full-content file that concatenates the complete `2.x` documentation into a single file.
16+
17+
```txt
18+
https://react-native-gesture-image-viewer.pages.dev/llms-full.txt
19+
```
20+
21+
Choose the file that best fits your use case:
22+
23+
- `llms.txt` is smaller and consumes fewer tokens, so it works well when AI should fetch specific pages on demand.
24+
- `llms-full.txt` contains the complete documentation for the current version, so AI does not need to follow individual links. This is useful for broader understanding or larger refactors, but it consumes more tokens.
25+
26+
## Markdown docs
27+
28+
Every documentation page also has a corresponding Markdown version that can be passed directly to AI.
29+
30+
Examples:
31+
32+
```txt
33+
https://react-native-gesture-image-viewer.pages.dev/guide/getting-started/overview.md
34+
https://react-native-gesture-image-viewer.pages.dev/guide/getting-started/quick-start.md
35+
https://react-native-gesture-image-viewer.pages.dev/guide/usage/programmatic-control.md
36+
```
37+
38+
Providing a single Markdown page is often the most efficient option when you want help with one specific feature.

β€Ždocs/docs/2.x/ko/guide/getting-started/_meta.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["overview", "installation", "quick-start"]
1+
["overview", "installation", "quick-start", "ai"]

β€Ždocs/docs/2.x/ko/guide/getting-started/ai.mdxβ€Ž

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# AI
2+
3+
AIκ°€ 이 라이브러리의 κΈ°λŠ₯, 버전별 λ¬Έμ„œ, ν”„λ‘œμ νŠΈ κ·œμΉ™μ„ 더 잘 μ΄ν•΄ν•΄μ„œ κ°œλ°œμ΄λ‚˜ νŠΈλŸ¬λΈ”μŠˆνŒ… κ³Όμ •μ—μ„œ 더 μ •ν™•ν•œ 도움을 쀄 수 μžˆλ„λ‘, 이 ν”„λ‘œμ νŠΈλŠ” λ‹€μŒ κΈ°λŠ₯듀을 μ œκ³΅ν•©λ‹ˆλ‹€.
4+
5+
## llms.txt
6+
7+
[`llms.txt`](https://llmstxt.org/)λŠ” LLM이 ν”„λ‘œμ νŠΈ λ¬Έμ„œλ₯Ό 더 μ‰½κ²Œ νƒμƒ‰ν•˜κ³  ν™œμš©ν•  수 μžˆλ„λ‘ λ•λŠ” ν‘œμ€€μž…λ‹ˆλ‹€. 이 μ‚¬μ΄νŠΈλŠ” λ‹€μŒ νŒŒμΌλ“€μ„ μ œκ³΅ν•©λ‹ˆλ‹€.
8+
9+
- [llms.txt](https://react-native-gesture-image-viewer.pages.dev/llms.txt): `2.x` λ¬Έμ„œμš© κ΅¬μ‘°ν™”λœ 인덱슀 파일
10+
11+
```txt
12+
https://react-native-gesture-image-viewer.pages.dev/llms.txt
13+
```
14+
15+
- [llms-full.txt](https://react-native-gesture-image-viewer.pages.dev/llms-full.txt): `2.x` λ¬Έμ„œ 전체λ₯Ό ν•˜λ‚˜λ‘œ ν•©μΉœ 파일
16+
17+
```txt
18+
https://react-native-gesture-image-viewer.pages.dev/llms-full.txt
19+
```
20+
21+
μ‚¬μš© λͺ©μ μ— 따라 μ μ ˆν•œ νŒŒμΌμ„ μ„ νƒν•˜λ©΄ λ©λ‹ˆλ‹€.
22+
23+
- `llms.txt`λŠ” 더 μž‘κ³  κ°€λ²Όμ›Œμ„œ ν•„μš”ν•œ λ¬Έμ„œλ§Œ μ„ νƒμ μœΌλ‘œ κ°€μ Έμ˜¬ λ•Œ μ ν•©ν•©λ‹ˆλ‹€.
24+
- `llms-full.txt`λŠ” ν•΄λ‹Ή 버전 λ¬Έμ„œ 전체λ₯Ό ν•œ λ²ˆμ— μ œκ³΅ν•˜λ―€λ‘œ, 넓은 λ²”μœ„μ˜ μ΄ν•΄λ‚˜ 큰 λ¦¬νŒ©ν„°λ§ μž‘μ—…μ— μ ν•©ν•©λ‹ˆλ‹€.
25+
26+
## Markdown docs
27+
28+
λͺ¨λ“  λ¬Έμ„œ νŽ˜μ΄μ§€λŠ” AIμ—κ²Œ 직접 전달할 수 μžˆλŠ” Markdown 버전도 ν•¨κ»˜ μ œκ³΅ν•©λ‹ˆλ‹€.
29+
30+
μ˜ˆμ‹œ:
31+
32+
```txt
33+
https://react-native-gesture-image-viewer.pages.dev/guide/getting-started/overview.md
34+
https://react-native-gesture-image-viewer.pages.dev/guide/getting-started/quick-start.md
35+
https://react-native-gesture-image-viewer.pages.dev/guide/usage/programmatic-control.md
36+
```
37+
38+
νŠΉμ • κΈ°λŠ₯ ν•˜λ‚˜λ§Œ λ¬Όμ–΄λ³Ό λ•ŒλŠ” 전체 λ¬Έμ„œλ³΄λ‹€ κ΄€λ ¨ Markdown νŽ˜μ΄μ§€ ν•˜λ‚˜λ₯Ό μ œκ³΅ν•˜λŠ” 편이 더 νš¨μœ¨μ μž…λ‹ˆλ‹€.

β€Ždocs/package.jsonβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
"preview": "rspress preview"
1010
},
1111
"devDependencies": {
12-
"@rspress/core": "^2.0.3",
13-
"@shikijs/transformers": "^3.22.0",
12+
"@rspress/core": "^2.0.9",
13+
"@shikijs/transformers": "^4.0.2",
1414
"@types/node": "^22.16.0",
1515
"typescript": "^5.8.3"
1616
}

0 commit comments

Comments
Β (0)