Skip to content

Commit

Permalink
docs: fix broken relative links in docs (run-llama#513)
Browse files Browse the repository at this point in the history
  • Loading branch information
TechPandaPro authored Feb 4, 2024
1 parent 955e084 commit 6fe55d6
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion apps/docs/docs/getting_started/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ LlamaIndex.TS help you prepare the knowledge base with a suite of data connector
[**Data Loaders**](../modules/data_loader.md):
A data connector (i.e. `Reader`) ingest data from different data sources and data formats into a simple `Document` representation (text and simple metadata).

[**Documents / Nodes**](../modules/documents_and_nodes.md): A `Document` is a generic container around any data source - for instance, a PDF, an API output, or retrieved data from a database. A `Node` is the atomic unit of data in LlamaIndex and represents a "chunk" of a source `Document`. It's a rich representation that includes metadata and relationships (to other nodes) to enable accurate and expressive retrieval operations.
[**Documents / Nodes**](../modules/documents_and_nodes/index.md): A `Document` is a generic container around any data source - for instance, a PDF, an API output, or retrieved data from a database. A `Node` is the atomic unit of data in LlamaIndex and represents a "chunk" of a source `Document`. It's a rich representation that includes metadata and relationships (to other nodes) to enable accurate and expressive retrieval operations.

[**Data Indexes**](../modules/data_index.md):
Once you've ingested your data, LlamaIndex helps you index data into a format that's easy to retrieve.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/docs/getting_started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ Our examples use OpenAI by default. You'll need to set up your Open AI key like
export OPENAI_API_KEY="sk-......" # Replace with your key from https://platform.openai.com/account/api-keys
```

If you want to have it automatically loaded every time, add it to your .zshrc/.bashrc.
If you want to have it automatically loaded every time, add it to your `.zshrc/.bashrc`.

WARNING: do not check in your OpenAI key into version control.
2 changes: 1 addition & 1 deletion apps/docs/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ For more complex applications, our lower-level APIs allow advanced users to cust

`npm install llamaindex`

Our documentation includes [Installation Instructions](./installation.mdx) and a [Starter Tutorial](./starter.md) to build your first application.
Our documentation includes [Installation Instructions](./getting_started/installation.mdx) and a [Starter Tutorial](./getting_started/starter.md) to build your first application.

Once you're up and running, [High-Level Concepts](./getting_started/concepts.md) has an overview of LlamaIndex's modular architecture. For more hands-on practical examples, look through our [End-to-End Tutorials](./end_to_end.md).

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/docs/modules/agent/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ An “agent” is an automated reasoning and decision engine. It takes in a user

LlamaIndex.TS comes with a few built-in agents, but you can also create your own. The built-in agents include:

- [OpenAI Agent](./openai.md)
- [OpenAI Agent](./openai.mdx)
6 changes: 3 additions & 3 deletions apps/docs/docs/modules/query_engines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ You can learn more about Tools by taking a look at the LlamaIndex Python documen

## API Reference

- [RetrieverQueryEngine](../api/classes/RetrieverQueryEngine.md)
- [SubQuestionQueryEngine](../api/classes/SubQuestionQueryEngine.md)
- [QueryEngineTool](../api/interfaces//QueryEngineTool.md)
- [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md)
- [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md)
- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md)

0 comments on commit 6fe55d6

Please sign in to comment.