From 8f6adce955d0bc5bbf7ed1ed35752c2554c99c13 Mon Sep 17 00:00:00 2001
From: Li Yin <li.yin.gravity@gmail.com>
Date: Fri, 5 Jul 2024 12:26:42 -0700
Subject: [PATCH] Update .gitattributes to fix language detection, avoid
 notebook overwhelm the python language

---
 .gitattributes                        |  2 ++
 README.md                             |  6 +++---
 docs/source/developer_notes/index.rst |  2 +-
 docs/source/index.rst                 | 10 +++++-----
 4 files changed, 11 insertions(+), 9 deletions(-)
 create mode 100644 .gitattributes

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 000000000..a9cd75701
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+*.ipynb linguist-language=Jupyter Notebook
+*.ipynb linguist-vendored
diff --git a/README.md b/README.md
index 61a9a1628..3b5b289d3 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@ class Net(nn.Module):
       x = self.fc1(x)
       return self.fc2(x)
 ``` -->
-## LightRAG Task Pipeline
+# LightRAG Task Pipeline
 
 
 We will ask the model to respond with ``explaination`` and ``example`` of a concept. And we will build a pipeline to get the structured output as ``QAOutput``.
@@ -193,7 +193,7 @@ You:
 ````
 
 
-## Quick Install
+# Quick Install
 
 Install LightRAG with pip:
 
@@ -220,7 +220,7 @@ LightRAG full documentation available at [lightrag.sylph.ai](https://lightrag.sy
 
 
 
-## Contributors
+# Contributors
 
 [![contributors](https://contrib.rocks/image?repo=SylphAI-Inc/LightRAG&max=2000)](https://github.com/SylphAI-Inc/LightRAG/graphs/contributors)
 
diff --git a/docs/source/developer_notes/index.rst b/docs/source/developer_notes/index.rst
index 025137804..804d2b39a 100644
--- a/docs/source/developer_notes/index.rst
+++ b/docs/source/developer_notes/index.rst
@@ -7,7 +7,7 @@ Tutorials
 .. *Why and How Each Part works*
 
 Learn the `why` and `how-to` (customize and integrate) behind each core part within the `LightRAG` library.
-These are our most important tutorials before you move ahead to build use cases  (LLM applications) end to end.
+These are our most important tutorials before you move ahead to build your use cases end to end.
 
 
 .. raw::
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 8f80ffe41..9054da458 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -158,12 +158,12 @@ Researchers will want their code to be adapted into more products too.
 
 
 .. Hide the use cases for now
-.. toctree::
-   :maxdepth: 1
-   :caption: Use Cases - How different parts are used to build various LLM applications
-   :hidden:
+   toctree::
+   .. :maxdepth: 1
+   .. :caption: Use Cases - How different parts are used to build various LLM applications
+   .. :hidden:
 
-   tutorials/index
+   .. tutorials/index
 
 
 .. toctree::