Skip to content

Commit

Permalink
fix: docs migration issues
Browse files Browse the repository at this point in the history
  • Loading branch information
thucpn committed Dec 20, 2024
1 parent cf29ca1 commit ee86f36
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 57 deletions.
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
40 changes: 39 additions & 1 deletion apps/next/src/content/docs/llamaindex/getting_started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ description: Install llamaindex by running a single command.
---

import { Tab, Tabs } from "fumadocs-ui/components/tabs";
import {
SiNodedotjs,
SiTypescript,
SiNextdotjs,
SiCloudflareworkers,
SiVite
} from "@icons-pack/react-simple-icons";

<Tabs groupId="install" items={["npm", "yarn", "pnpm"]} persist>
```shell tab="npm"
Expand All @@ -19,13 +26,44 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
```
</Tabs>

<Cards>
<Card title={
<>
<SiNodedotjs className="inline" color="#5FA04E" /> Node.js
</>
} href="/docs/llamaindex/getting_started/setup/node" />
<Card title={
<>
<SiTypescript className="inline" color="#3178C6" /> TypeScript
</>
} href="/docs/llamaindex/getting_started/setup/typescript" />
<Card title={
<>
<SiVite className='inline' color='#646CFF' /> Vite
</>
} href="/docs/llamaindex/getting_started/setup/vite" />
<Card
title={
<>
<SiNextdotjs className='inline' /> Next.js (React Server Component)
</>
}
href="/docs/llamaindex/getting_started/setup/next"
/>
<Card title={
<>
<SiCloudflareworkers className='inline' color='#F38020' /> Cloudflare Workers
</>
} href="/docs/llamaindex/getting_started/setup/cloudflare" />
</Cards>

## What's next?

<Cards>
<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/next"
/>
<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

This file was deleted.

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": ["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
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"]
}

0 comments on commit ee86f36

Please sign in to comment.