Fix get started links and notebooks (#15)

Fix link on Get Started and add Notebooks nav panel
microsoft · Apr 2, 2024 · ad349e9 · ad349e9
1 parent e59a24a
commit ad349e9
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 4 deletions.
diff --git a/javascript/docsite/_includes/page.njk b/javascript/docsite/_includes/page.njk
@@ -83,6 +83,13 @@ title: GraphRAG
                 {%- for post in collections.orchestration -%}
                 <li>{{link_to(post.url, post.data.navtitle)}}</li>
                 {%- endfor -%}
+                <li>
+                  {{link_to("/_posts/_query/notebooks/overview/", "Notebooks")}}
+                  <ul>
+                    <li>{{link_to("/_posts/_query/notebooks/global_search_nb", "Global Search")}}</li>
+                    <li>{{link_to("/_posts/_query/notebooks/local_search_nb", "Local Search")}}</li>
+                  </ul>
+                </li>
             </ul>
             </li>
           </ul>

diff --git a/javascript/docsite/_posts/_query/notebooks/global_search_nb.md b/javascript/docsite/_posts/_query/notebooks/global_search_nb.md
@@ -2,7 +2,8 @@
 title: Global Search Notebook
 navtitle: Global Search
 layout: page
-tags: [post, orchestration]
+tags: [post, notebooks]
+01date: 2024-04-01
 ---
 
 ```python

diff --git a/javascript/docsite/_posts/_query/notebooks/local_search_nb.md b/javascript/docsite/_posts/_query/notebooks/local_search_nb.md
@@ -1,8 +1,8 @@
 ---
 title: Local Search Notebook
-navtitle: Local Search
+navtitle: Local Search Notebook
 layout: page
-tags: [post, orchestration]
+tags: [post, notebook]
 ---
 
 ```python

diff --git a/javascript/docsite/_posts/_query/notebooks/overview.md b/javascript/docsite/_posts/_query/notebooks/overview.md
@@ -0,0 +1,11 @@
+---
+title: Query Engine Notebooks
+navtitle: Query Engine Notebooks
+layout: page
+tags: [post, notebook]
+---
+
+For examples about running Query please refer to the following notebooks:
+
+- [Global Search Notebook](../global_search_nb)
+- [Local Search Notebook](../local_search_nb)
diff --git a/javascript/docsite/_posts/get_started.md b/javascript/docsite/_posts/get_started.md
@@ -76,7 +76,7 @@ set GRAPHRAG_LLM_MODEL=<chat_completions_model>
 set GRAPHRAG_EMBEDDING_MODEL=<embeddings_model>
 ```
 
-For more details about Environment Variables configuration please refer to the Query Engine [CLI documentation](../_query/cli).
+For more details about Environment Variables configuration please refer to the Query Engine [CLI documentation](../_query/3-cli).
 
 ## Running the Query Engine