Skip to content

Commit 82fdff5

Browse files
Improve setup instructions (#10)
* fix urls * improve setup instructions * change ordered list
1 parent f0e434d commit 82fdff5

File tree

4 files changed

+20
-17
lines changed

4 files changed

+20
-17
lines changed

.devcontainer/devcontainer.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
"customizations": {
66
"codespaces": {
77
"openFiles": [
8-
"INSTRUCTIONS.adoc",
8+
"SETUP.md",
99
".env.example",
1010
"llm-vectors-unstructured/test_environment.py"
1111
]
1212
},
1313
"vscode": {
1414
"settings": {
15-
"python.createEnvironment.trigger": "off"
15+
"python.createEnvironment.trigger": "off",
16+
"workbench.editorAssociations": {
17+
"*.md": "vscode.markdown.preview.editor"
18+
}
1619
},
1720
"extensions": [
1821
"ms-python.python",

INSTRUCTIONS.adoc

Lines changed: 0 additions & 13 deletions
This file was deleted.

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
= Introduction to Vector Indexes and Unstructured Data
22

3-
This repository accompanies the link:graphacademy.neo4j.com/courses/llm-vectors-unstructured[Introduction to Vector Indexes and Unstructured Data^] on link:graphacademy.neo4j.com/courses/genai-workshop[GraphAcademy^].
3+
This repository accompanies the link:https://graphacademy.neo4j.com/courses/llm-vectors-unstructured/[Introduction to Vector Indexes and Unstructured Data^] on link:https://graphacademy.neo4j.com[GraphAcademy^].
44

5-
For a complete walkthrough of this repository, link:graphacademy.neo4j.com/courses/llm-vectors-unstructured[enrol now^].
5+
For a complete walkthrough of this repository, link:https://graphacademy.neo4j.com/courses/llm-vectors-unstructured/[enrol now^].
66

77
== Tests
88

SETUP.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Setup
2+
3+
This repository accompanies the [Introduction to Vector Indexes and Unstructured Data course](https://graphacademy.neo4j.com/courses/llm-vectors-unstructured) on [GraphAcademy](https://graphacademy.neo4j.com).
4+
5+
When the devcontainer is created, such as in a GitHub codespace, all the required software and packages will be installed.
6+
7+
Follow the [Setup Instructions in GraphAcademy](https://graphacademy.neo4j.com/courses/llm-vectors-unstructured/3-unstructured-data/0-setup/) to get started.
8+
9+
You will need to:
10+
11+
1. Create a new [`.env`](.env) file and copy the contents of the [`.env.example`](.env.example) file into it
12+
2. Update the environment values in the [`.env`](.env) file with the values in the [Setup Instructions](https://graphacademy.neo4j.com/courses/genai-workshop/1-knowledge-graphs-vectors/1-getting-started/)
13+
3. Run the [`llm-vectors-unstructured/test_environment.py`](./llm-vectors-unstructured/test_environment.py) program to check the environment is set up correctly.

0 commit comments

Comments
 (0)