From 5cf5da71d18c2313dd6d1294f78b28c3f110d113 Mon Sep 17 00:00:00 2001 From: Ashok Gelal Date: Wed, 10 Jul 2024 09:56:44 -0400 Subject: [PATCH] add .mstyignore --- app.config.ts | 20 ++--- content/1.getting-started/1.onboarding.md | 4 +- .../1.download-offline-models.md | 2 +- .../2.use-existing-ollama-models.md} | 6 +- ...re files and folders in Knowledge Stack.md | 74 +++++++++++++++++++ content/2.how-to guides/_dir.yml | 3 + content/2.how-to/_dir.yml | 3 - 7 files changed, 93 insertions(+), 19 deletions(-) rename content/{2.how-to => 2.how-to guides}/1.download-offline-models.md (96%) rename content/{2.how-to/use-existing-ollama-models.md => 2.how-to guides/2.use-existing-ollama-models.md} (90%) create mode 100644 content/2.how-to guides/3.ignore files and folders in Knowledge Stack.md create mode 100644 content/2.how-to guides/_dir.yml delete mode 100644 content/2.how-to/_dir.yml diff --git a/app.config.ts b/app.config.ts index 019242f..d218c15 100644 --- a/app.config.ts +++ b/app.config.ts @@ -6,7 +6,7 @@ export default defineAppConfig({ "Get started with guides and resources to maximize your conversational AI experience with Msty.", }, theme: { - customizable: true, + customizable: false, color: "blue", radius: 0.5, }, @@ -20,11 +20,11 @@ export default defineAppConfig({ }, nav: [], links: [ - { - icon: "tabler:brand-github", - to: "https://github.com/CloudStack-LLC/msty-docs", - target: "_blank", - }, + // { + // icon: "tabler:brand-github", + // to: "https://github.com/CloudStack-LLC/msty-docs", + // target: "_blank", + // }, ], }, aside: { @@ -36,17 +36,17 @@ export default defineAppConfig({ showTitle: true, }, footer: { - credits: "Copyright © 2024", + credits: "Copyright © 2024. CloudStack, LLC", links: [ { - icon: "tabler:brand-github", - to: "https://github.com/CloudStack-LLC/msty-docs", + icon: "ph:cube", + to: "https://msty.app?ref=docs", target: "_blank", }, ], }, toc: { - enable: true, + enable: false, title: "On This Page", links: [ { diff --git a/content/1.getting-started/1.onboarding.md b/content/1.getting-started/1.onboarding.md index 1cd64a5..a1de383 100644 --- a/content/1.getting-started/1.onboarding.md +++ b/content/1.getting-started/1.onboarding.md @@ -18,7 +18,7 @@ Download Msty Supported platforms: Windows, Mac, Linux. :: -::alert{type="info" icon="solar:info-circle-linear"} +::alert{type="info" icon="tabler:info-circle"} Once you have Msty installed and open, you can use **any** of the following steps to complete the onboarding. :: @@ -88,7 +88,7 @@ Msty currently supports the following online model providers: :: :: -::alert{type="info" icon="solar:info-circle-linear"} +::alert{type="info" icon="tabler:info-circle"} You may need to obtain the appropriate API key from your model provider to use its models in Msty. :: diff --git a/content/2.how-to/1.download-offline-models.md b/content/2.how-to guides/1.download-offline-models.md similarity index 96% rename from content/2.how-to/1.download-offline-models.md rename to content/2.how-to guides/1.download-offline-models.md index 75f304a..b513e7c 100644 --- a/content/2.how-to/1.download-offline-models.md +++ b/content/2.how-to guides/1.download-offline-models.md @@ -1,6 +1,6 @@ --- title: Download Offline Models -description: Learn how to download offline models in Msty +description: --- Msty lets you download a wide variety of models to use offline with Local AI. You can choose to install any model from Ollama or import supported `gguf` model files from HuggingFace, directly within Msty. diff --git a/content/2.how-to/use-existing-ollama-models.md b/content/2.how-to guides/2.use-existing-ollama-models.md similarity index 90% rename from content/2.how-to/use-existing-ollama-models.md rename to content/2.how-to guides/2.use-existing-ollama-models.md index 34bc9b3..3921bfb 100644 --- a/content/2.how-to/use-existing-ollama-models.md +++ b/content/2.how-to guides/2.use-existing-ollama-models.md @@ -1,6 +1,6 @@ --- title: Use existing Ollama Models -description: Learn how to use your existing Ollama models with Msty +description: --- Msty can share models download location with Ollama. This allows you to use the models that you have already downloaded prior to installing Msty on your computer, as well as continue using them with Ollama if necessary. @@ -42,10 +42,10 @@ Ollama models are generally located under: :: :: -::alert{type="info" icon="solar:info-circle-linear"} +::alert{type="info" icon="tabler:info-circle"} If you changed your Ollama models path using the `OLLAMA_MODELS` environment variable, then you'll need to use the path you set instead of the default locations mentioned above. :: :: -Once you confirm the changes, Local AI service will restart for the changes to take effect. Once the service is running, you'll be able to see the models you have downloaded from Ollama in the model selector and chat with them in Msty. \ No newline at end of file +Once you confirm the changes, Local AI service will restart for the changes to take effect. Once the service is running, you'll be able to see the models you have downloaded from Ollama in the model selector and chat with them in Msty. diff --git a/content/2.how-to guides/3.ignore files and folders in Knowledge Stack.md b/content/2.how-to guides/3.ignore files and folders in Knowledge Stack.md new file mode 100644 index 0000000..e92bf12 --- /dev/null +++ b/content/2.how-to guides/3.ignore files and folders in Knowledge Stack.md @@ -0,0 +1,74 @@ +--- +title: Ignore files and folders in Knowledge Stack +description: +--- + +The `.mstyignore` file is a powerful tool allows you to specify which files and folders should be ignored when composing your knowledge stack. By using `.mstyignore`, you can streamline your knowledge base, exclude unnecessary files, and maintain a cleaner, more focused stack. + +### Understanding .mstyignore Syntax + +Good news for those familiar with Git: `.mstyignore` uses the same syntax as `.gitignore`. This means if you're already comfortable with `.gitignore`, you'll find `.mstyignore` intuitive and easy to use. For those new to this syntax, don't worry – it's straightforward and easy to learn. + +### How to Create and Use a .mstyignore File + +1. Create a new file named "`.mstyignore`" in the root directory of your knowledge stack folders or Obsidian vaults. +2. Open the file in a text editor. +3. Add patterns for files and folders you want to ignore, one per line. +4. Save the file. + +### Syntax Rules and Pattern Examples + +Here are some common patterns and what they do: +1. Ignore specific files: + example.txt + +2. Ignore all files with a certain extension: + *.log + +3. Ignore all files in a specific folder: + folder_name/ + +4. Ignore a specific folder and all its contents: + folder_name/** + +5. Ignore files or folders that match a pattern: + **/temp_* + +6. Negate a pattern (include a file that would otherwise be ignored): + !important.txt + +Practical Examples + +Here's an example of what your `.mstyignore` file might look like: + +``` +# Ignore all .log files +*.log + +# Ignore the entire 'temp' folder +temp/ + +# Ignore all .tmp files in any directory +**/*.tmp + +# Ignore all files in the 'drafts' folder +drafts/ + +# But don't ignore important drafts +!drafts/important_draft.md + +# Ignore all files starting with 'temp_' +temp_* + +# Ignore all files ending with '_old' +*_old +``` + +### Best Practices + +1. Keep your `.mstyignore` file in the root directory of your knowledge stack. +2. Use comments (lines starting with #) to explain complex patterns. +3. Be specific to avoid accidentally ignoring important files. +4. Regularly review and update your `.mstyignore` file as your knowledge stack evolves. + +By effectively using `.mstyignore`, you can maintain a clean, relevant, and efficient knowledge stack in Misty AI. This allows you to focus on the information that matters most, improving the overall quality and usefulness of your AI assistant. diff --git a/content/2.how-to guides/_dir.yml b/content/2.how-to guides/_dir.yml new file mode 100644 index 0000000..e0cd61a --- /dev/null +++ b/content/2.how-to guides/_dir.yml @@ -0,0 +1,3 @@ +title: How-to Guides +icon: tabler:directions +navigation.redirect: /how-to-guides/download-offline-models diff --git a/content/2.how-to/_dir.yml b/content/2.how-to/_dir.yml deleted file mode 100644 index 3bf30bd..0000000 --- a/content/2.how-to/_dir.yml +++ /dev/null @@ -1,3 +0,0 @@ -title: How to -icon: solar:info-circle-linear -navigation.redirect: /how-to/download-offline-models