updated the docs folder structure

leafmonkeylabs · Sep 13, 2024 · 39d4b2c · 39d4b2c
1 parent 6229a72
commit 39d4b2c
Show file tree

Hide file tree

Showing 15 changed files with 37 additions and 14 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,22 +1,31 @@
 <!-- markdownlint-disable first-line-h1 -->
 
 - Quick Start
-    - [Installation](installation.md)
-    - [Minimum Working Example](minimum-example.md)
+    - [Installation](quick-start/installation.md)
+    - [Minimum Working Example](quick-start/minimum-example.md)
 - Building Blocks
-    - [Semantic Type](semantic-type.md)
-    - [Large Language Model](large-language-model.md)
-    - [With LLM](with-llm.md)
-    - [Tools](tools.md)
-    - [Methods](methods.md)
-- Guide
-    - [Best Practices](best-practices.md)
-    - [Community Tutorials](community-tutorials.md)
+    - [Semantic Type](building-blocks/semantic-type.md)
+    - [Large Language Model](building-blocks/large-language-model.md)
+    - [With LLM](building-blocks/with-llm.md)
+    - [Tools](building-blocks/tools.md)
+    - [Methods](building-blocks/methods.md)
+- Guides
+    - [Best Practices](guides/best-practices.md)
+    - [Tutorials](guides/tutorials.md)
 - API Reference
-    - [semantix](semantix.md)
-    - [llms](llms.md)
-    - [types](types.md)
-    - [utils](utils.md)
+    - [semantix](api-ref/semantix.md)
+    - LLMs
+        - [OpenAI](api-ref/openai.md)
+        - [Anthropic](api-ref/anthropic.md)
+        - [Cohere](api-ref/cohere.md)
+        - [TogetherAI](api-ref/togetherai.md)
+    - [types](api-ref/types.md)
+    - [utils](api-ref/utils.md)
+- Community
+    - [Projects](community/projects.md)
+    - [Contributors](community/contributors.md)
+    - [Citation](community/citation.md)
+    - [Social Media](community/social-media.md)
 - [Roadmap](roadmap.md)
 - [FAQ](faq.md)
 - [Contributing](contributing.md)

diff --git a/docs/large-language-model.md → docs/building-blocks/large-language-model.md b/docs/large-language-model.md → docs/building-blocks/large-language-model.md
diff --git a/docs/methods.md → docs/building-blocks/methods.md b/docs/methods.md → docs/building-blocks/methods.md
diff --git a/docs/semantic-type.md → docs/building-blocks/semantic-type.md b/docs/semantic-type.md → docs/building-blocks/semantic-type.md
diff --git a/docs/tools.md → docs/building-blocks/tools.md b/docs/tools.md → docs/building-blocks/tools.md
diff --git a/docs/with-llm.md → docs/building-blocks/with-llm.md b/docs/with-llm.md → docs/building-blocks/with-llm.md
diff --git a/docs/community-tutorials.md → docs/community/citation.md b/docs/community-tutorials.md → docs/community/citation.md
diff --git a/docs/customisability.md → docs/community/contributors.md b/docs/customisability.md → docs/community/contributors.md
diff --git a/docs/community/projects.md b/docs/community/projects.md
diff --git a/docs/community/social-media.md b/docs/community/social-media.md
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,11 @@
+# FAQ
+
+### Whats the Difference between `semantix` and other libraries such as `DSPy`, `Instructor` etc?
+
+Libraries such as `DSPy`, `Instructor` etc. are JSON Schema based Structured Output Generators. Though they are powerful, they come with few caveats.
+
+1. Uses PyDantic Models. Though pydantic provide robust type validation, uses have to extend all the types to `BaseModel` which is not always necessary.
+2. Unnecessary Abstractions. Libraries like `DSPy` uses unnecessary abstractions to embed meaning into variables (`InputField`, `OutputField` etc). Classes like `dspy.Signature` are not necessary because already python function signatures, type hints and output type hints are expressive enough to convey the objective.
+3. In most LLMs, characters such as `{`, `}`, `:`, `"` etc are considered as seperate tokens. So in the inference you will be charged for each of these tokens alot because JSON Schema are heavily composed of these characters.
+
+`Semantix` on the other hand uses `Semantic` types to embed meaning into variables. `Semantic` types are just a wrapper around the original type and a string that represents the meaning of the type. This allows you to write more expressive, powerful code with ease without any use of unnecessary abstractions. and it is not a must as well. You can use `Semantic` types only when you need to embed meaning into variables.
diff --git a/docs/best-practices.md → docs/guides/best-practices.md b/docs/best-practices.md → docs/guides/best-practices.md
diff --git a/docs/guides/tutorials.md b/docs/guides/tutorials.md
@@ -0,0 +1,3 @@
+# Tutorials
+
+Submissions to the tutorials section are welcome. Please refer to the [contributing guidelines](contributing.md) for more information.
diff --git a/docs/installation.md → docs/quick-start/installation.md b/docs/installation.md → docs/quick-start/installation.md
diff --git a/docs/minimum-example.md → docs/quick-start/minimum-example.md b/docs/minimum-example.md → docs/quick-start/minimum-example.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Tutorials

		Submissions to the tutorials section are welcome. Please refer to the [contributing guidelines](contributing.md) for more information.