From e073e43d19fc84062153db73058ed8fc3f83230f Mon Sep 17 00:00:00 2001 From: eckartal <159995642+eckartal@users.noreply.github.com> Date: Tue, 12 Mar 2024 13:39:53 +0300 Subject: [PATCH 1/5] Create faq.md --- docs/docs/faq.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/docs/faq.md diff --git a/docs/docs/faq.md b/docs/docs/faq.md new file mode 100644 index 000000000..9e6f6bdf9 --- /dev/null +++ b/docs/docs/faq.md @@ -0,0 +1,37 @@ +# Frequently Asked Questions (FAQ) + +## How does Jan ensure my data remains private? + +Jan prioritizes your privacy by running open-source AI models 100% offline on your computer, ensuring all conversations, documents, and files stay private. + +## Can I use Jan without an internet connection? + +Yes, Jan can run locally without an internet connection for many features. + +## Is Jan compatible with my operating system? + +Jan is available for Mac, Windows, Linux, ensuring wide compatibility. + +## Are there any costs associated with using Jan? + +Jan is free to use. However, if you opt to connect to remote APIs, you will need to cover those services' costs according to their pricing, not Jan's. + +## What types of AI models can I download or import with Jan? + +You can download popular AI models or import any model of your choice through Jan's Hub. + +## How do I customize Jan using the programmable API? + +The API allows you to tailor Jan to your needs, but specific details on usage would require consulting Jan's documentation. + +## How can I contribute to Jan's development or suggest features? + +Contributions can be made through GitHub and Discord, where you can also suggest features and contribute. + +## How can I get involved with the Jan community? + +Joining [Jan's Discord server](https://discord.gg/qSwXFx6Krr) is a great way to get involved with the community. + +## How do I troubleshoot issues with installing or using Jan? + +For troubleshooting, you should reach out on Discord and check GitHub for assistance and support from the community and the development team. From da9b9c60c7d070e0cdf4c271bea08a20306b65f3 Mon Sep 17 00:00:00 2001 From: eckartal <159995642+eckartal@users.noreply.github.com> Date: Thu, 14 Mar 2024 20:35:20 +0300 Subject: [PATCH 2/5] Update faq.md - Added new questions - Updated some answers --- docs/docs/faq.md | 40 ++++++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/docs/docs/faq.md b/docs/docs/faq.md index 9e6f6bdf9..0ab0944cc 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -1,20 +1,40 @@ # Frequently Asked Questions (FAQ) -## How does Jan ensure my data remains private? +## What is Jan? -Jan prioritizes your privacy by running open-source AI models 100% offline on your computer, ensuring all conversations, documents, and files stay private. +Jan is software that helps you run large language models (LLMs) on your everyday tasks. For details, read the [About page](https://jan.ai/about/). -## Can I use Jan without an internet connection? +## How do I use Jan? -Yes, Jan can run locally without an internet connection for many features. +Download Jan to your computer, choose a compatible LLM, or connect to a remote AI with the API code to start. You can switch between them as needed. ## Is Jan compatible with my operating system? Jan is available for Mac, Windows, Linux, ensuring wide compatibility. +## Do you use my data? + +No. See our data and analytics policy [here](https://jan.ai/privacy/#:~:text=We%20do%20not%20share%20your,with%20a%20better%20user%20experience.). + +## Do you sell my data? + +No. We don't even track your data. Jan is yours. + +## How does Jan ensure my data remains private? + +Jan prioritizes your privacy by running open-source AI models 100% offline on your computer, ensuring all conversations, documents, and files stay private. + +## What does "Jan" stand for? + +Jan stands for “Just Another Neuron”, as we are passionate about building software that complements in your existing neural pathways. But in the spirit of full transparency, it was also just a nice 3 letter domain name we owned 😂. + +## Can I use Jan without an internet connection? + +Yes, Jan can run locally without an internet connection for many features. + ## Are there any costs associated with using Jan? -Jan is free to use. However, if you opt to connect to remote APIs, you will need to cover those services' costs according to their pricing, not Jan's. +Jan is free to use. However, if you want to connect to remote APIs, like GPT-4, you will need to put in your own API key. ## What types of AI models can I download or import with Jan? @@ -26,7 +46,7 @@ The API allows you to tailor Jan to your needs, but specific details on usage wo ## How can I contribute to Jan's development or suggest features? -Contributions can be made through GitHub and Discord, where you can also suggest features and contribute. +Contributions can be made through [GitHub](https://github.com/janhq/jan) and [Discord](https://discord.gg/Exe46xPMbK), where you can also suggest features and contribute. ## How can I get involved with the Jan community? @@ -35,3 +55,11 @@ Joining [Jan's Discord server](https://discord.gg/qSwXFx6Krr) is a great way to ## How do I troubleshoot issues with installing or using Jan? For troubleshooting, you should reach out on Discord and check GitHub for assistance and support from the community and the development team. + +## Can I self host? + +Yes! We love the self-hosted movement. Jan is available as a Helm chart / docker composes which can be run across home servers or even production level environments. + +## Are you hiring? + +We often hire directly from our community. If you are interested to apply, please see our careers page [here](https://janai.bamboohr.com/careers). From 9181ec1f387e73a3cd00cc5f7445a369f0844713 Mon Sep 17 00:00:00 2001 From: eckartal <159995642+eckartal@users.noreply.github.com> Date: Thu, 14 Mar 2024 20:46:16 +0300 Subject: [PATCH 3/5] Rename docs/docs/faq.md to docs/docs/about/faq.md Moved under /about --- docs/docs/{ => about}/faq.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/docs/{ => about}/faq.md (100%) diff --git a/docs/docs/faq.md b/docs/docs/about/faq.md similarity index 100% rename from docs/docs/faq.md rename to docs/docs/about/faq.md From 0a544a1ebb8dddf60a767e31fafef54ab2dfe19b Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:16:01 +0900 Subject: [PATCH 4/5] docs: update sidebar and faq --- docs/docs/about/faq.md | 8 ++++---- docs/sidebars.js | 15 +++++++++++---- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/docs/about/faq.md b/docs/docs/about/faq.md index 0ab0944cc..29832e211 100644 --- a/docs/docs/about/faq.md +++ b/docs/docs/about/faq.md @@ -10,7 +10,7 @@ Download Jan to your computer, choose a compatible LLM, or connect to a remote A ## Is Jan compatible with my operating system? -Jan is available for Mac, Windows, Linux, ensuring wide compatibility. +Jan is available for Mac, Windows, and Linux, ensuring wide compatibility. ## Do you use my data? @@ -56,10 +56,10 @@ Joining [Jan's Discord server](https://discord.gg/qSwXFx6Krr) is a great way to For troubleshooting, you should reach out on Discord and check GitHub for assistance and support from the community and the development team. -## Can I self host? +## Can I self-host? -Yes! We love the self-hosted movement. Jan is available as a Helm chart / docker composes which can be run across home servers or even production level environments. +Yes! We love the self-hosted movement. Jan is available as a Helm chart/ Docker composes which can be run across home servers or even production-level environments. ## Are you hiring? -We often hire directly from our community. If you are interested to apply, please see our careers page [here](https://janai.bamboohr.com/careers). +We often hire directly from our community. If you are interested in applying, please see our careers page [here](https://janai.bamboohr.com/careers). diff --git a/docs/sidebars.js b/docs/sidebars.js index b95e4044f..beb7856a9 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -29,6 +29,13 @@ const sidebars = { link: { type: "doc", id: "team/team" }, items: ["team/join-us", "team/contributor-program"], }, + { + type: "category", + label: "FAQ", + link: { type: "doc", id: "about/faq" }, + items: + [], + }, "wall-of-love", { type: "category", @@ -222,10 +229,10 @@ const sidebars = { }, items: [ "guides/extensions/import-ext", - "guides/extensions/setup-ext", + "guides/extensions/setup-ext", ] }, - { + { type: "category", label: "Integrations", className: "head_SubMenu", @@ -233,7 +240,7 @@ const sidebars = { type: 'doc', id: "guides/integration/README", }, - items: [ + items: [ "guides/integration/azure", "guides/integration/discord", "guides/integration/groq", @@ -243,7 +250,7 @@ const sidebars = { "guides/integration/openinterpreter", "guides/integration/openrouter", "guides/integration/raycast", - "guides/integration/vscode", + "guides/integration/vscode", ] }, ] From a571c8be28ebebf00bd9f08b826ad333ad2ac922 Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:26:59 +0900 Subject: [PATCH 5/5] docs: change order --- docs/sidebars.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sidebars.js b/docs/sidebars.js index beb7856a9..a9eba0015 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -29,13 +29,6 @@ const sidebars = { link: { type: "doc", id: "team/team" }, items: ["team/join-us", "team/contributor-program"], }, - { - type: "category", - label: "FAQ", - link: { type: "doc", id: "about/faq" }, - items: - [], - }, "wall-of-love", { type: "category", @@ -59,6 +52,13 @@ const sidebars = { ], }, "acknowledgements", + { + type: "category", + label: "FAQ", + link: { type: "doc", id: "about/faq" }, + items: + [], + }, ], productSidebar: [ {