license, docs.home

MarkParker5 · Sep 18, 2023 · 0bf42df · 0bf42df
1 parent f3163a6
commit 0bf42df
Show file tree

Hide file tree

Showing 24 changed files with 124 additions and 32 deletions.
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/docs/index.md → docs/advanced/commands-context.md b/docs/index.md → docs/advanced/commands-context.md
diff --git a/docs/advanced/custom-interfaces.md b/docs/advanced/custom-interfaces.md
diff --git a/docs/advanced/custom-run.md b/docs/advanced/custom-run.md
diff --git a/docs/advanced/external-triggers.md b/docs/advanced/external-triggers.md
diff --git a/docs/advanced/fallback-command.md b/docs/advanced/fallback-command.md
diff --git a/docs/advanced/localization-and-multi-language.md b/docs/advanced/localization-and-multi-language.md
diff --git a/docs/advanced/optimization.md b/docs/advanced/optimization.md
diff --git a/docs/advanced/other.md b/docs/advanced/other.md
diff --git a/docs/advanced/voice-assistant.md b/docs/advanced/voice-assistant.md
diff --git a/docs/command-response.md b/docs/command-response.md
diff --git a/docs/commands-context.md b/docs/commands-context.md
diff --git a/docs/contributing-and-shared-usage-stark-place.md b/docs/contributing-and-shared-usage-stark-place.md
@@ -0,0 +1,10 @@
+# Contributing and Shared Usage
+
+[STARK-PLACE](https://github.com/MarkParker5/STARK-PLACE) repository is a platform library with community extensions. Use commands created by others and feel free to share yours!
+
+
+
+
+### License
+
+Project is licensed under
diff --git a/docs/creating-commands.md b/docs/creating-commands.md
diff --git a/docs/dependency-injection.md b/docs/dependency-injection.md
diff --git a/docs/first-steps.md b/docs/first-steps.md
@@ -0,0 +1 @@
+# First Steps
diff --git a/docs/home.md b/docs/home.md
@@ -0,0 +1,37 @@
+# Welcome to S.T.A.R.K.
+
+**Speech and Text Algorithmic Recognition Kit**
+
+Welcome to S.T.A.R.K., a modern, advanced, asynchronous, and fast framework designed for creating intuitive natural language interfaces, especially voice-based. Think of it as the [FastAPI](https://fastapi.tiangolo.com/) but with speech instead of http.
+
+New to S.T.A.R.K.? Consider reading the articles in navigation sequentially for a comprehensive understanding of the framework, including the "Advanced" section.
+
+---
+
+### 🔍 Key Features:
+
+- **🛡️ Autonomous and Privacy-Focused**: Stark operates entirely on-device, ensuring your data remains private. Dive deeper into hosting options [here](/where-to-host).
+
+- **🧠 Context-Aware**: Easily define context and parameters for subsequent requests or parse multiple commands simultaneously. Discover the power of [Commands Context](/commands-context).
+
+- **🚀 Asynchronous Commands**: Start lengthy tasks and continue using Stark You'll be notified upon completion. Learn about [Sync vs Async Commands](/sync-vs-async-commands) and the intricacies of [Creating Commands](/creating-commands).
+
+- **📈 Multiple Responses**: Get real-time updates for long tasks, like monitoring download progress. More on this in [Creating Commands](/creating-commands).
+
+- **🧩 Advanced Patterns Parsing**: Our custom [patterns](/patterns) syntax makes parsing any parameter from strings effortless.
+
+- 🧠 **Extendable with LLMs**: Enhance Stark's cognition by integrating leading language models like ChatGPT.
+
+- 🌐 **Multilingual Support**: Interact with Stark in [multiple languages](/advanced/localization-and-multi-language).
+
+- **🔧 Absolute Customization**: Craft complex commands, integrate various speech or text interfaces, adapt voice assistant modes, or even override existing classes.
+
+- **🌍 Community Support**: Join [STARK-PLACE](https://github.com/MarkParker5/STARK-PLACE) repository, the platform library filled with community extensions. Utilize commands crafted by others and share your creations. Further information in [Contributing and Shared Usage](/contributing-and-shared-usage).
+
+---
+
+### License
+
+The S.T.A.R.K. project is licensed under the [CC BY-NC-SA 4.0 International license](https://github.com/MarkParker5/STARK/tree/master/LICENSE.md). You're welcome to modify, contribute to the repository, create, and share forks. Just remember to attribute the original repository and its creator, abstain from commercial use, and retain the existing license.
+
+**Note**: Failing to provide the necessary attribution or using the project for commercial purposes breaches the licensing terms and could have legal consequences.
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,2 @@
+# Installation
+
diff --git a/docs/patterns.md b/docs/patterns.md
diff --git a/docs/sync-vs-async-commands.md b/docs/sync-vs-async-commands.md
diff --git a/docs/voice-assistant.md b/docs/voice-assistant.md
diff --git a/docs/where-to-host.md b/docs/where-to-host.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,7 +9,33 @@ repo_url: https://github.com/MarkParker5/STARK
 
 copyright: Copyright &copy; Mark Parker
 
-# nav:
+nav:
+  - Home: home.md # Home, description, all features list, where to find commands, license, usefull links
+  - Contributing and Shared Usage: contributing-and-shared-usage.md # Contributing, shared usage, code of conduct, license
+  - Installation: installation.md
+  - First Steps: first-steps.md
+  - Sync vs Async Commands: sync-vs-async-commands.md # TLDR and in depth about worker threads and asyncify
+  - Creating Commands: creating-commands.md # manager.new, join managers, return, yield (async, sync), handler.respond and unrespond (sync and async), call subcommands (sync and async)
+  - Patterns: patterns.md # pattern syntax, parameters parsing, native types, custom object types, nested objects, advanced parsing with did_parse
+  - Command Response: command-response.md # every property explanation
+  - Dependency Injection: dependency-injection.md # response handler, inject_dependency, get DIContainer, add custom dependency, create a custom container
+  - Commands Context: commands-context.md # context explanation, adding context in response, pop context, multiple commands in request
+  - Voice Assistant: voice-assistant.md # Modes, repeating, context handling
+  - Default Speech Interfaces: # STT, TTS
+  - Where to Host: where-to-host.md # personal computer: system.d or windows tray, raspberry pi: system.d, iOS: in development, android: not implemented
+  - Advanced Usage:
+    - Optimization: advanced/optimization.md # worker threads, asyncify, asyncer group, caching
+    - Custom Run: advanced/custom-run.md # custom event loop, blocking detector, typer
+    - Fallback Command: advanced/fallback-command.md # Fallback command setting and available implementations
+    - External Triggers: advanced/external-triggers.md # external triggers
+    - Localization and Multi-Language: advanced/localization-and-multi-language.md # TODO: Localization, multi-language
+    - Custom Interfaces: advanced/custom-interfaces.md # stt, tts, text: telebot.
+    # - Speech Recognition: advanced/speech-recognition.md # available engines, create custom
+    # - Speech Synthesis: advanced/speech-synthesis.md # available engines, create custom
+    - Voice Assistant: advanced/voice-assistant.md # methods for overrides
+    - Commands Context: advanced/commands-context.md # methods for overrides
+    - Other: # read the code
+
 
 theme:
   name: material

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,9 +1,9 @@
 [tool.poetry]
 name = "stark"
-version = "0.1.0"
+version = "4.0.0"
 description = ""
 authors = ["MarkParker5 <[email protected]>"]
-license = "CC BY-NC-ND 4.0"
+license = "CC BY-NC-SA 4.0"
 readme = "README.md"
 packages = [{include = "stark"}]