Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: docs migration issues #1576

Merged
merged 3 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Getting Started with LlamaIndex.TS
title: Installation
description: Install llamaindex by running a single command.
---

Expand All @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Getting Started
title: Choose Framework
description: We support multiple JS runtime and frameworks, bundlers.
---
import {
Expand All @@ -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>
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion apps/next/src/content/docs/llamaindex/guide/meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Guide",
"description": "See our guide",
"pages": ["workflow", "chat", "agents", "loading", "cost-analysis"]
"pages": ["loading", "workflow", "chat", "agents", "cost-analysis"]
}
Loading