From c7fc17086a2ba621648ae6bb277c4bbc11c17429 Mon Sep 17 00:00:00 2001
From: Kartheek Yakkala <yakkalakartheek@gmail.com>
Date: Fri, 5 Jan 2024 09:29:44 -0600
Subject: [PATCH] Updated links in documentation (#9856)
---
.github/ISSUE_TEMPLATE/config.yml | 2 +-
.github/ISSUE_TEMPLATE/question-form.yml | 2 +-
.vscode/settings.json | 2 +-
CONTRIBUTING.md | 12 ++++++------
.../discord_dumps/help_channel_dump_05_25_23.json | 6 +++---
llama_index/playground/base.py | 2 +-
6 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index dea3fe3583..328c418634 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: LlamaIndex Documentation
- url: https://gpt-index.readthedocs.io/en/latest/index.html
+ url: https://docs.llamaindex.ai/en/latest/index.html
about: Please review/search the latest documentation before posting an issue.
- name: LlamaIndex Community Support
url: https://discord.gg/dGcwcsnxhU
diff --git a/.github/ISSUE_TEMPLATE/question-form.yml b/.github/ISSUE_TEMPLATE/question-form.yml
index be8cccdaab..4bc584fc1d 100644
--- a/.github/ISSUE_TEMPLATE/question-form.yml
+++ b/.github/ISSUE_TEMPLATE/question-form.yml
@@ -12,7 +12,7 @@ body:
id: pre-question
attributes:
label: Question Validation
- description: By submitting this issue, you agree that you've previously search our [documentation](https://gpt-index.readthedocs.io/en/latest/index.html) and [discord](https://discord.gg/dGcwcsnxhU) and did not find a proper answer to your question.
+ description: By submitting this issue, you agree that you've previously search our [documentation](https://docs.llamaindex.ai/en/latest/index.html) and [discord](https://discord.gg/dGcwcsnxhU) and did not find a proper answer to your question.
options:
- label: I have searched both the documentation and discord for an answer.
required: true
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 5e83196967..10c72dab77 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -2,7 +2,7 @@
"[python]": {
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
- "source.fixAll": true
+ "source.fixAll": "explicit"
},
"editor.defaultFormatter": "ms-python.black-formatter"
},
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 19d16f2270..0942d993b6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -100,7 +100,7 @@ Under the hood, LlamaIndex also supports a swappable **storage layer** that allo
We have an underlying key-value abstraction backing the document/index stores.
Currently we support in-memory and MongoDB storage for these stores. Open to contributions!
-See [Storage guide](https://gpt-index.readthedocs.io/en/latest/how_to/storage.html) for details.
+See [Storage guide](https://docs.llamaindex.ai/en/stable/module_guides/storing/kv_stores.html) for details.
---
@@ -111,7 +111,7 @@ A managed index is used to represent an index that's managed via an API, exposin
Currently we support the [VectaraIndex](https://github.com/run-llama/llama_index/tree/ca09272af000307762d301c99da46ddc70d3bfd2/llama_index/indices/managed/vectara).
Open to contributions!
-See [Managed Index docs](https://gpt-index.readthedocs.io/en/stable/community/integrations/managed_indices.html) for details.
+See [Managed Index docs](https://docs.llamaindex.ai/en/stable/community/integrations/managed_indices.html) for details.
---
@@ -137,7 +137,7 @@ These serve as the main data store and retrieval engine for our vector index.
- See a vector database out there that we don't support yet? Make a PR!
-See [reference](https://gpt-index.readthedocs.io/en/latest/reference/indices/vector_stores/stores.html) for full details.
+See [reference](https://docs.llamaindex.ai/en/stable/api_reference/indices/vector_store.html) for full details.
---
@@ -199,7 +199,7 @@ This can interpreted as a pre-processing stage, before the core index query logi
- [Hypothetical Document Embeddings](https://github.com/jerryjliu/llama_index/blob/main/llama_index/indices/query/query_transform/base.py#L77)
- [Query Decompose](https://github.com/jerryjliu/llama_index/blob/main/llama_index/indices/query/query_transform/base.py#L124)
-See [guide](https://gpt-index.readthedocs.io/en/latest/how_to/query/query_transformations.html#hyde-hypothetical-document-embeddings) for more information.
+See [guide](https://docs.llamaindex.ai/en/stable/optimizing/advanced_retrieval/query_transformations.html#hyde-hypothetical-document-embeddings) for more information.
---
@@ -243,7 +243,7 @@ A output parser enables us to extract structured output from the plain text outp
- [Guardrails Output Parser](https://github.com/jerryjliu/llama_index/blob/main/llama_index/output_parsers/guardrails.py)
- [Langchain Output Parser](https://github.com/jerryjliu/llama_index/blob/main/llama_index/output_parsers/langchain.py)
-See [guide](https://gpt-index.readthedocs.io/en/latest/how_to/output_parsing.html) for more information.
+See [guide](https://docs.llamaindex.ai/en/stable/module_guides/querying/structured_outputs/output_parser.html) for more information.
---
@@ -261,7 +261,7 @@ Please feel free to open an issue and/or assign an issue to yourself.
If you have applied LlamaIndex to a unique use-case (e.g. interesting dataset, customized index structure, complex query), we would love your contribution in the form of:
-1. a guide: e.g. [guide to LlamIndex + Structured Data](https://gpt-index.readthedocs.io/en/latest/guides/tutorials/sql_guide.html)
+1. a guide: e.g. [guide to LlamIndex + Structured Data](https://docs.llamaindex.ai/en/stable/understanding/putting_it_all_together/structured_data.html)
2. an example notebook: e.g. [Composable Indices Demo](https://github.com/jerryjliu/llama_index/blob/main/docs/examples/composable_indices/ComposableIndices-Prior.ipynb)
### 4. 🧪 Add Experimental Features
diff --git a/docs/examples/discover_llamaindex/document_management/discord_dumps/help_channel_dump_05_25_23.json b/docs/examples/discover_llamaindex/document_management/discord_dumps/help_channel_dump_05_25_23.json
index 70b35ad139..40fd55ac22 100644
--- a/docs/examples/discover_llamaindex/document_management/discord_dumps/help_channel_dump_05_25_23.json
+++ b/docs/examples/discover_llamaindex/document_management/discord_dumps/help_channel_dump_05_25_23.json
@@ -5555,7 +5555,7 @@
"timestampEdited": null,
"callEndedTimestamp": null,
"isPinned": false,
- "content": "I don't see an obvious parameter here unless I'm supposed to override a helper or something https://gpt-index.readthedocs.io/en/latest/reference/query.html",
+ "content": "I don't see an obvious parameter here unless I'm supposed to override a helper or something https://docs.llamaindex.ai/en/stable/understanding/querying/querying.html",
"author": {
"id": "412315621511004160",
"name": "gojira",
@@ -6082,7 +6082,7 @@
"timestampEdited": null,
"callEndedTimestamp": null,
"isPinned": false,
- "content": "Lucky you was just reading this: https://gpt-index.readthedocs.io/en/latest/how_to/embeddings.html#custom-embeddings",
+ "content": "Lucky you was just reading this: https://docs.llamaindex.ai/en/stable/examples/embeddings/custom_embeddings.html",
"author": {
"id": "192452798871371776",
"name": "yourbuddyconner",
@@ -6294,7 +6294,7 @@
"timestampEdited": null,
"callEndedTimestamp": null,
"isPinned": false,
- "content": "Yes. check parsing response here - https://gpt-index.readthedocs.io/en/latest/guides/usage_pattern.html",
+ "content": "Yes. check parsing response here - https://docs.llamaindex.ai/en/stable/module_guides/models/prompts/usage_pattern.html",
"author": {
"id": "941249850597572618",
"name": "ravitheja",
diff --git a/llama_index/playground/base.py b/llama_index/playground/base.py
index 4f51efa817..864daaf334 100644
--- a/llama_index/playground/base.py
+++ b/llama_index/playground/base.py
@@ -45,7 +45,7 @@ class Playground:
retriever_modes: A list of retriever_modes that specify which nodes are
chosen from the index when a query is made. A full list of
retriever_modes available to each index can be found here:
- https://gpt-index.readthedocs.io/en/latest/reference/query.html
+ https://docs.llamaindex.ai/en/stable/module_guides/querying/retriever/retriever_modes.html
"""
self._validate_indices(indices)
self._indices = indices
--
GitLab