Add note about expected broken notebook in docs

natoverse · natoverse · commit bad577c47219 · 2025-10-06T16:29:02.000-07:00
diff --git a/docs/examples_notebooks/api_overview.ipynb b/docs/examples_notebooks/api_overview.ipynb
@@ -67,6 +67,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# note that we expect this to fail on the deployed docs because the PROJECT_DIRECTORY is not set to a real location.\n",
+    "# if you run this notebook locally, make sure to point at a location containing your settings.yaml\n",
     "graphrag_config = load_config(Path(PROJECT_DIRECTORY))"
    ]
   },

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,8 @@`
`67`	`67`	`"metadata": {},`
`68`	`68`	`"outputs": [],`
`69`	`69`	`"source": [`
	`70`	`+ "# note that we expect this to fail on the deployed docs because the PROJECT_DIRECTORY is not set to a real location.\n",`
	`71`	`+ "# if you run this notebook locally, make sure to point at a location containing your settings.yaml\n",`
`70`	`72`	`"graphrag_config = load_config(Path(PROJECT_DIRECTORY))"`
`71`	`73`	`]`
`72`	`74`	`},`