Merge pull request #151 from raymyers/main

Doc spellcheck
dot-agent · Mar 21, 2024 · f8e87f7 · f8e87f7
2 parents 055de2a + 79ff66c
commit f8e87f7
Show file tree

Hide file tree

Showing 18 changed files with 21 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -149,7 +149,7 @@ Check out your app by visiting [http://localhost:3000](http://localhost:3000)
 
 ## 🎨 Start with a template!
 
-We speedup your development with a [ever growing list of community templates](https://github.com/dot-agent/nextpy/tree/main/app-examples). Some examples:
+We speedup your development with an [ever growing list of community templates](https://github.com/dot-agent/nextpy/tree/main/app-examples). Some examples:
 
 <table border="0">
   <tr>
@@ -319,6 +319,6 @@ Want to know more? Check out our manifesto! https://nextpy.org/manifesto/
 ## 🙏 Thanks
 
 
-Nextpy Framework is a state-of-the-art app development framerwork optimized for AI-based code generation, built on the open-source community’s spirit of cooperation. It integrates key components from landmark projects like Guidance, Llama-Index, FastAPI-Mail, LangChain, ReactPy, Reflex, Chakra, Radix, Numpy and Next.js, while also drawing insights from the React and Rust ecosystems. This fusion ideas has been pivotal in shaping Nextpy into a framework that's not just AI-friendly but also a trailblazer in generative web development tools.
+Nextpy Framework is a state-of-the-art app development framework optimized for AI-based code generation, built on the open-source community’s spirit of cooperation. It integrates key components from landmark projects like Guidance, Llama-Index, FastAPI-Mail, LangChain, ReactPy, Reflex, Chakra, Radix, Numpy and Next.js, while also drawing insights from the React and Rust ecosystems. This fusion ideas has been pivotal in shaping Nextpy into a framework that's not just AI-friendly but also a trailblazer in generative web development tools.
 
 We are deeply grateful to the open-source creators, contributors, and maintainers whose work has provided the basis for Nextpy. Your commitment to innovation and openness has been vital for shaping this framework. Your contributions have not only enhanced Nextpy but are also advancing the new era of AI-powered software development. Thank you for being the catalysts and enablers of this transformational journey.
diff --git a/docs/ai/01_engine.md b/docs/ai/01_engine.md
@@ -2,9 +2,9 @@
 
 The engine is designed to process prompts efficiently for large language models (LLMs), offering users the ability to create very controlled text generation . This tool integrates the flexibility of regular expressions and context-free grammars (CFGs) to restrict and guide output. Additionally, it provides mechanisms to interweave control structures like conditionals and loops with text generation, allowing for more complex interactions.  
 
-For opensource models using key-value (KV) caches, the engine can maintain state across interactions with LLMs, which is particularly useful when dealing with long and complicated prompts. This stateful approach minimizes redundant generation steps, leading to faster responses when handling detailed prompts. 
+For open-weight models using key-value (KV) caches, the engine can maintain state across interactions with LLMs, which is particularly useful when dealing with long and complicated prompts. This stateful approach minimizes redundant generation steps, leading to faster responses when handling detailed prompts. 
 
-This module furthers the development of what is now an depricated version of guidance. It leverages templating mechanisms to centralize the logic of prompt creation, leading to a workflow that is both more streamlined and maintainable. 
+This module furthers the development of what is now a deprecated version of guidance. It leverages templating mechanisms to centralize the logic of prompt creation, leading to a workflow that is both more streamlined and maintainable. 
 
 Key Features:  
 - **Prompt Templates**: These are the core of the engine, allowing for dynamic text generation by using placeholders that can be filled with variable content.  
@@ -262,7 +262,7 @@ program()
 ```  
 In the example above, we enclose all of the text in one of the valid role tags for the model. The role tags are `system`, `user`, and `assistant`.  
 
-### Multistep  
+### Multi-step  
 
 ```python  
 experts = engine('''\n  

diff --git a/docs/frontend/01_components.md b/docs/frontend/01_components.md
@@ -1,7 +1,7 @@
 
 # What are Components?
 
-- Components are like building blocks for crafting a app's interface, allowing modular and reusable design elements.
+- Components are like building blocks for crafting an app's interface, allowing modular and reusable design elements.
 - Components in Nextpy are defined using Python functions. They encapsulate React components, providing a Pythonic development experience without requiring JavaScript knowledge.
 - A component can range from simple text to interactive buttons or dynamic progress bars.
 

diff --git a/docs/get_started/01_nextpy_quickstart.md b/docs/get_started/01_nextpy_quickstart.md
@@ -47,7 +47,7 @@ Check out your app by visiting [http://localhost:3000](http://localhost:3000)
 
 ## 🎨 Start with a template!
 
-We speedup your development with a [ever growing list of community templates](https://github.com/dot-agent/nextpy/tree/main/app-examples). Some examples:
+We speedup your development with an [ever growing list of community templates](https://github.com/dot-agent/nextpy/tree/main/app-examples). Some examples:
 
 <table border="0">
   <tr>

diff --git a/docs/🌎/Español/README.md b/docs/🌎/Español/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Español, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Español, please consider submitting a pull request with improvements
 
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Logo de Nextpy" width="320px">

diff --git a/docs/🌎/Français/README.md b/docs/🌎/Français/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Français, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Français, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Logo Nextpy" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Logo Nextpy" width="320px">

diff --git a/docs/🌎/German/README.md b/docs/🌎/German/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in German, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in German, please consider submitting a pull request with improvements
 
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Nextpy Logo" width="320px">

diff --git a/docs/🌎/Italiano/README.md b/docs/🌎/Italiano/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Italiano, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Italiano, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Logo di Nextpy" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Logo di Nextpy" width="320px">

diff --git a/docs/🌎/Português/README.md b/docs/🌎/Português/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Português, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Português, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Logotipo do Nextpy" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Logotipo do Nextpy" width="320px">

diff --git a/docs/🌎/Tamil/README.md b/docs/🌎/Tamil/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Tamil, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Tamil, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Nextpy லோகோ" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Nextpy லோகோ" width="320px">

diff --git a/docs/🌎/Türkçe/README.md b/docs/🌎/Türkçe/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Türkçe, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Türkçe, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Nextpy Logo" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Nextpy Logo" width="320px">

diff --git a/docs/🌎/Ukrainian/README.md b/docs/🌎/Ukrainian/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in Ukrainian, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in Ukrainian, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Логотип Nextpy" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Логотип Nextpy" width="320px">

diff --git a/docs/🌎/русский/README.md b/docs/🌎/русский/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in русский, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in русский, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Логотип Nextpy" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Логотип Nextpy" width="320px">

diff --git a/docs/🌎/عربي/README.md b/docs/🌎/عربي/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in عربي, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in عربي, please consider submitting a pull request with improvements
 
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="شعار Nextpy" width="320px">

diff --git a/docs/🌎/हिंदी/README.md b/docs/🌎/हिंदी/README.md
@@ -1,6 +1,6 @@
 > [!CAUTION] 
 
-> This is LLM generated translation. If you are proficient in Hindi, please consider submitting a pull request with improvements 
+> This is an LLM generated translation. If you are proficient in Hindi, please consider submitting a pull request with improvements 
 
 
 

diff --git a/docs/🌎/简体中文/README.md b/docs/🌎/简体中文/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in 简体中文, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in 简体中文, please consider submitting a pull request with improvements
 
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Nextpy Logo" width="320px">

diff --git a/docs/🌎/繁體中文/README.md b/docs/🌎/繁體中文/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in 繁體中文, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in 繁體中文, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Nextpy 標誌" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Nextpy 標誌" width="320px">

diff --git a/docs/🌎/한국어/README.md b/docs/🌎/한국어/README.md
@@ -1,5 +1,5 @@
 > [!CAUTION]
-> This is LLM geenrated translation. If you are proficient in 한국어, please consider submitting a pull request with improvements
+> This is an LLM generated translation. If you are proficient in 한국어, please consider submitting a pull request with improvements
 <div align="center">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_light_theme.svg#gh-light-mode-only" alt="Nextpy 로고" width="320px">
 <img src="https://raw.githubusercontent.com/dotagent-ai/assets/main/nextpy_logo_dark_theme.svg#gh-dark-mode-only" alt="Nextpy 로고" width="320px">