diff --git a/README.md b/README.md index 171499c197..fc0a07ee8e 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: +See our official document: ### 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 f77fa845a0..01e71a398f 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"; Also, you need have the basic understanding of Cloudflare Worker. 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 f65880d920..aa4a012530 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 { <> Node.js - } href="/docs/llamaindex/setup/node" /> + } href="/docs/llamaindex/getting_started/setup/node" /> TypeScript - } href="/docs/llamaindex/setup/typescript" /> + } href="/docs/llamaindex/getting_started/setup/typescript" /> Vite - } href="/docs/llamaindex/setup/vite" /> + } href="/docs/llamaindex/getting_started/setup/vite" /> Next.js (React Server Component) } - href="/docs/llamaindex/setup/next" + href="/docs/llamaindex/getting_started/setup/next" /> Cloudflare Workers - } href="/docs/llamaindex/setup/cloudflare" /> - + } href="/docs/llamaindex/getting_started/setup/cloudflare" /> + \ 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 7d84e67070..2a5e97a348 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 135e1543e4..7f7ab87ed5 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 ## 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 dd06e41f95..e49bc79c09 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 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 441727707e..c75c8fed93 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 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 2da654d1e8..eef95d0e80 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 e925192cd1..e88d93efe5 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 d03e40e3ac..b5d74a767e 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"] }