From 4a831b192c58d01b86a8bdec481091db2fb6f7a9 Mon Sep 17 00:00:00 2001
From: Thuc Pham <51660321+thucpn@users.noreply.github.com>
Date: Fri, 20 Dec 2024 16:42:54 +0700
Subject: [PATCH] fix: docs migration issues (#1576)
---
README.md | 2 +-
.../docs/llamaindex/getting_started/index.mdx | 4 ++--
.../getting_started/setup/cloudflare.mdx | 2 +-
.../setup/{getting-started.mdx => index.mdx} | 14 +++++++-------
.../llamaindex/getting_started/setup/meta.json | 9 +--------
.../docs/llamaindex/getting_started/setup/next.mdx | 2 +-
.../docs/llamaindex/getting_started/setup/node.mdx | 2 +-
.../docs/llamaindex/getting_started/setup/vite.mdx | 2 +-
.../retrieval_augmented_generation.mdx | 2 +-
.../structured_data_extraction.mdx | 2 +-
.../src/content/docs/llamaindex/guide/meta.json | 2 +-
11 files changed, 18 insertions(+), 25 deletions(-)
rename apps/next/src/content/docs/llamaindex/getting_started/setup/{getting-started.mdx => index.mdx} (67%)
diff --git a/README.md b/README.md
index 171499c19..fc0a07ee8 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,7 @@ yarn add llamaindex
### Setup in Node.js, Deno, Bun, TypeScript...?
-See our official document: <https://ts.llamaindex.ai/docs/llamaindex/setup/getting-started>
+See our official document: <https://ts.llamaindex.ai/docs/llamaindex/getting_started/>
### Tips when using in non-Node.js environments
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/index.mdx b/apps/next/src/content/docs/llamaindex/getting_started/index.mdx
index f77fa845a..01e71a398 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/index.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/index.mdx
@@ -1,5 +1,5 @@
---
-title: Getting Started with LlamaIndex.TS
+title: Installation
description: Install llamaindex by running a single command.
---
@@ -25,7 +25,7 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
<Card
title="I want to try LlamaIndex.TS"
description="Learn how to use LlamaIndex.TS with different JS runtime and frameworks."
- href="/docs/llamaindex/setup/getting-started"
+ href="/docs/llamaindex/getting_started/setup"
/>
<Card
title="Show me code examples"
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/setup/cloudflare.mdx b/apps/next/src/content/docs/llamaindex/getting_started/setup/cloudflare.mdx
index 5ed244b91..895ff0838 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/setup/cloudflare.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/setup/cloudflare.mdx
@@ -14,7 +14,7 @@ Before you start, make sure you have try LlamaIndex.TS in Node.js to make sure y
<Card
title="Getting Started with LlamaIndex.TS in Node.js"
- href="/docs/llamaindex/setup/node"
+ href="/docs/llamaindex/getting_started/setup/node"
/>
Also, you need have the basic understanding of <a href='https://developers.cloudflare.com/workers/'><SiCloudflareworkers className="inline mr-2" color="#F38020" />Cloudflare Worker</a>.
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/setup/getting-started.mdx b/apps/next/src/content/docs/llamaindex/getting_started/setup/index.mdx
similarity index 67%
rename from apps/next/src/content/docs/llamaindex/getting_started/setup/getting-started.mdx
rename to apps/next/src/content/docs/llamaindex/getting_started/setup/index.mdx
index f65880d92..aa4a01253 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/setup/getting-started.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/setup/index.mdx
@@ -1,5 +1,5 @@
---
-title: Getting Started
+title: Choose Framework
description: We support multiple JS runtime and frameworks, bundlers.
---
import {
@@ -15,28 +15,28 @@ import {
<>
<SiNodedotjs className="inline" color="#5FA04E" /> Node.js
</>
- } href="/docs/llamaindex/setup/node" />
+ } href="/docs/llamaindex/getting_started/setup/node" />
<Card title={
<>
<SiTypescript className="inline" color="#3178C6" /> TypeScript
</>
- } href="/docs/llamaindex/setup/typescript" />
+ } href="/docs/llamaindex/getting_started/setup/typescript" />
<Card title={
<>
<SiVite className='inline' color='#646CFF' /> Vite
</>
- } href="/docs/llamaindex/setup/vite" />
+ } href="/docs/llamaindex/getting_started/setup/vite" />
<Card
title={
<>
<SiNextdotjs className='inline' /> Next.js (React Server Component)
</>
}
- href="/docs/llamaindex/setup/next"
+ href="/docs/llamaindex/getting_started/setup/next"
/>
<Card title={
<>
<SiCloudflareworkers className='inline' color='#F38020' /> Cloudflare Workers
</>
- } href="/docs/llamaindex/setup/cloudflare" />
-</Cards>
+ } href="/docs/llamaindex/getting_started/setup/cloudflare" />
+</Cards>
\ No newline at end of file
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/setup/meta.json b/apps/next/src/content/docs/llamaindex/getting_started/setup/meta.json
index 7d84e6707..2a5e97a34 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/setup/meta.json
+++ b/apps/next/src/content/docs/llamaindex/getting_started/setup/meta.json
@@ -2,12 +2,5 @@
"title": "Setup",
"description": "The setup guide",
"defaultOpen": true,
- "pages": [
- "getting-started",
- "next",
- "node",
- "typescript",
- "vite",
- "cloudflare"
- ]
+ "pages": ["index", "next", "node", "typescript", "vite", "cloudflare"]
}
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/setup/next.mdx b/apps/next/src/content/docs/llamaindex/getting_started/setup/next.mdx
index 135e1543e..7f7ab87ed 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/setup/next.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/setup/next.mdx
@@ -7,7 +7,7 @@ Before you start, make sure you have try LlamaIndex.TS in Node.js to make sure y
<Card
title="Getting Started with LlamaIndex.TS in Node.js"
- href="/docs/llamaindex/setup/node"
+ href="/docs/llamaindex/getting_started/setup/node"
/>
## Differences between Node.js and Next.js
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/setup/node.mdx b/apps/next/src/content/docs/llamaindex/getting_started/setup/node.mdx
index dd06e41f9..e49bc79c0 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/setup/node.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/setup/node.mdx
@@ -26,5 +26,5 @@ For more information, see the [How to read environment variables from Node.js](h
<Card
title="Getting Started with LlamaIndex.TS in TypeScript"
- href="/docs/llamaindex/setup/typescript"
+ href="/docs/llamaindex/getting_started/setup/typescript"
/>
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/setup/vite.mdx b/apps/next/src/content/docs/llamaindex/getting_started/setup/vite.mdx
index 441727707..c75c8fed9 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/setup/vite.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/setup/vite.mdx
@@ -7,7 +7,7 @@ Before you start, make sure you have try LlamaIndex.TS in Node.js to make sure y
<Card
title="Getting Started with LlamaIndex.TS in Node.js"
- href="/docs/llamaindex/setup/node"
+ href="/docs/llamaindex/getting_started/setup/node"
/>
Also, make sure you have a basic understanding of [Vite](https://vitejs.dev/).
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/retrieval_augmented_generation.mdx b/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/retrieval_augmented_generation.mdx
index 2da654d1e..eef95d0e8 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/retrieval_augmented_generation.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/retrieval_augmented_generation.mdx
@@ -17,7 +17,7 @@ npm init
npm install -D typescript @types/node
```
-Then, check out the [installation](../installation) steps to install LlamaIndex.TS and prepare an OpenAI key.
+Then, check out the [installation](../setup) steps to install LlamaIndex.TS and prepare an OpenAI key.
You can use [other LLMs](../../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm).
diff --git a/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/structured_data_extraction.mdx b/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/structured_data_extraction.mdx
index e925192cd..e88d93efe 100644
--- a/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/structured_data_extraction.mdx
+++ b/apps/next/src/content/docs/llamaindex/getting_started/starter_tutorial/structured_data_extraction.mdx
@@ -5,7 +5,7 @@ title: Structured data extraction tutorial
import { DynamicCodeBlock } from 'fumadocs-ui/components/dynamic-codeblock';
import CodeSource from "!raw-loader!../../../../../../../../examples/jsonExtract";
-Make sure you have installed LlamaIndex.TS and have an OpenAI key. If you haven't, check out the [installation](../installation) guide.
+Make sure you have installed LlamaIndex.TS and have an OpenAI key. If you haven't, check out the [installation](../setup) guide.
You can use [other LLMs](../../examples/other_llms) via their APIs; if you would prefer to use local models check out our [local LLM example](../../examples/local_llm).
diff --git a/apps/next/src/content/docs/llamaindex/guide/meta.json b/apps/next/src/content/docs/llamaindex/guide/meta.json
index d03e40e3a..b5d74a767 100644
--- a/apps/next/src/content/docs/llamaindex/guide/meta.json
+++ b/apps/next/src/content/docs/llamaindex/guide/meta.json
@@ -1,5 +1,5 @@
{
"title": "Guide",
"description": "See our guide",
- "pages": ["workflow", "chat", "agents", "loading", "cost-analysis"]
+ "pages": ["loading", "workflow", "chat", "agents", "cost-analysis"]
}
--
GitLab