diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md index 3b2759513..b12b5a3ab 100644 --- a/docs/docs/about/about.md +++ b/docs/docs/about/about.md @@ -1,7 +1,7 @@ --- title: About Jan slug: /about -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +description: Jan is a productivity tool to customize AI to your needs and workflows. keywords: [ Jan AI, @@ -15,111 +15,46 @@ keywords: ] --- +Jan is a [local-first](https://www.inkandswitch.com/local-first/) productivity tool to [create, customize and use AI](https://www.gatesnotes.com/AI-agents) for everyday tasks. + +You can: +- Run locally using [open-source LLMs](https://huggingface.co/models?pipeline_tag=text-generation) or connect to cloud AIs like [ChatGPT](https://openai.com/blog/openai-api) or [Google](https://ai.google.dev/) +- Fine-tune AI with specific knowledge +- Search the web and other databases +- Connect AI to your everyday tools and (with your permission) do work on your behalf + +Longer-term, Jan is building a cognitive framework for future robots. We envision a world where we have personal or company robots that we continually improve and customize, growing together with us. + +![Human repairing a Droid](/img/star-wars-droids.png) + +## Why do we exist + +At Jan, our mission is to advance human-machine collaboration. We achieve this through delivering the best AI tools on desktop to allow users to run, customize and tinker with AI. + +## What's different about it? + +Jan is + +## How do I get it? + +## What license is the code under? + +## What was it built with? + + + + + +Jan is built on an open-source, modular framework + + that runs on your own computer, with a local API server. It is a ChatGPT-alternative that is designed to be private, local, and free from subscription fees. + + + Jan believes in the need for an **open source AI ecosystem**. We are focused on building the infra and tooling to allow open source AIs to compete on a level playing field with proprietary ones. Jan's long-term technical endeavor is to build a cognitive framework for future robots, who are practical, useful assistants for humans and businesses in everyday life. -## Quicklinks - -- Core product vision for [Jan Framework](../docs) -- R&D and model training efforts [Discord](https://discord.gg/9NfUSyzp3y) (via our small data-center which is `free & open to all researchers who lack GPUs`!) -- Current implementations of Jan Framework: [Jan Desktop](https://jan.ai/), [Nitro](https://nitro.jan.ai/) - -## Why does Jan Exist? - -### Mission - -Our current mission is to allow humans and businesses to **own their AI, with the right to tinker, repair and innovate**. - -:::tip -Our life-long mission is to **eliminate work - so human can focus on creation, invention, and moral governance over robots**. -::: - -### Ideal Customer - -Our ideal customer is an AI enthusiast or business who has experienced some limitations with current AI solutions and is keen to find open source alternatives. - -### Problems - -Our ideal customer would use Jan to solve one of these problems. - -_Control_ - -- Control (e.g. preventing vendor lock-in) -- Stability (e.g. runs predictably every time) -- Local-use (e.g. for speed, or for airgapped environments) - -_Privacy_ - -- Data protection (e.g. personal data or company data) -- Privacy (e.g. nsfw) - -_Customisability_ - -- Tinkerability (e.g. ability to change model, experiment) -- Niche Models (e.g. fine-tuned, domain-specific models that outperform OpenAI) - -Sources: [^1] [^2] [^3] [^4] - -[^1]: [What are you guys doing that can't be done with ChatGPT?](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3) -[^2]: [What's your main interest in running a local LLM instead of an existing API?](https://www.reddit.com/r/LocalLLaMA/comments/1718a9o/whats_your_main_interest_in_running_a_local_llm/) -[^3]: [Ask HN: What's the best self-hosted/local alternative to GPT-4?](https://news.ycombinator.com/item?id=36138224) -[^4]: [LoRAs](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7mdz1i/?utm_source=share&utm_medium=web2x&context=3) - -### Solution - -Jan is a seamless user experience that runs on your personal computer, that glues the different pieces of the open source AI ecosystem to provide an alternative to OpenAI's closed platform. - -- We build a comprehensive, seamless platform that takes care of the technical chores across the stack required to run open source AI -- We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!) -- We provide open formats for packaging and distributing AI to run reproducibly across devices - -## How Jan Works - -### Open Source - -Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it. - -- [Jan Framework](https://github.com/janhq/jan) (AGPLv3) -- [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework) -- [Nitro: run Local AI](https://github.com/janhq/nitro) (AGPLv3) - -### Build in Public - -We use GitHub to build in public and welcome anyone to join in. - -- [Jan's Kanban](https://github.com/orgs/janhq/projects/5) -- [Jan's Roadmap](https://github.com/orgs/janhq/projects/5/views/29) -- [Jan's Newsletter](https://newsletter.jan.ai) - -### Remote Team - -Jan has a fully-remote team. We are mainly based in the APAC timezone. We use [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq) to work. - -### Bootstrapped - -Jan is currently a bootstrapped, founder funded startup. - -We balance technical invention with the search for a sustainable business model. Thus, we appreciate any business inquiries that can balance growth with cashflow. - -**We invite you to join us on our journey to find PMF**. Join our [Discord here](https://discord.gg/BnHRr3Q7Ms) - -### Analytics - -Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get `barely-enough-to-function`. - -#### What is tracked - -1. By default, Github tracks downloads and device metadata for all public Github repos. This helps us troubleshoot & ensure cross platform support. -1. We use Posthog to track a single `app.opened` event without additional user metadata, in order to understand retention. -1. Additionally, we plan to enable a `Settings` feature for users to turn off all tracking. - -#### Request for help - -As a result, our feature prioritization can feel a bit black box at times. - -We'd appreciate high quality insights and volunteers for user interviews through [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq). - ## Contact ### General Enquiries diff --git a/docs/docs/contributors.md b/docs/docs/contributors.md deleted file mode 100644 index f55ee2e16..000000000 --- a/docs/docs/contributors.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: How We Work ---- \ No newline at end of file diff --git a/docs/docs/contributors/product/README.md b/docs/docs/contributors/product/README.md deleted file mode 100644 index c07109800..000000000 --- a/docs/docs/contributors/product/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Product -slug: /product ---- - -## Prerequisites - -- [Figma](https://figma.com) -- [ScreenStudio](https://www.screen.studio/) diff --git a/docs/docs/how-we-work.md b/docs/docs/how-we-work.md new file mode 100644 index 000000000..b54f72399 --- /dev/null +++ b/docs/docs/how-we-work.md @@ -0,0 +1,24 @@ +--- +title: How We Work +--- + +### Open Source + +Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it. + +- [Jan Framework](https://github.com/janhq/jan) (AGPLv3) +- [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework) +- [Nitro: run Local AI](https://github.com/janhq/nitro) (AGPLv3) + +### Build in Public + +We use GitHub to build in public and welcome anyone to join in. + +- [Jan's Kanban](https://github.com/orgs/janhq/projects/5) +- [Jan's Roadmap](https://github.com/orgs/janhq/projects/5/views/29) +- [Jan's Newsletter](https://newsletter.jan.ai) + +### Remote Team + +Jan has a fully-remote team. We are mainly based in the APAC timezone. We use [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq) to work. + diff --git a/docs/docs/how-we-work/analytics/analytics.md b/docs/docs/how-we-work/analytics/analytics.md new file mode 100644 index 000000000..eecf80dcd --- /dev/null +++ b/docs/docs/how-we-work/analytics/analytics.md @@ -0,0 +1,11 @@ +--- +title: Analytics +--- + +Adhering to Jan's privacy preserving philosophy, our analytics philosophy is to get "barely-enough-to-function". + +#### What is tracked + +1. By default, Github tracks downloads and device metadata for all public Github repos. This helps us troubleshoot & ensure cross platform support. +1. We use Posthog to track a single `app.opened` event without additional user metadata, in order to understand retention. +1. Additionally, we plan to enable a `Settings` feature for users to turn off all tracking. \ No newline at end of file diff --git a/docs/docs/how-we-work/design/design.md b/docs/docs/how-we-work/design/design.md new file mode 100644 index 000000000..4ae1de322 --- /dev/null +++ b/docs/docs/how-we-work/design/design.md @@ -0,0 +1,3 @@ +--- +title: Design +--- \ No newline at end of file diff --git a/docs/docs/contributors/engineering/assets/01-get-help.png b/docs/docs/how-we-work/engineering/assets/01-get-help.png similarity index 100% rename from docs/docs/contributors/engineering/assets/01-get-help.png rename to docs/docs/how-we-work/engineering/assets/01-get-help.png diff --git a/docs/docs/contributors/engineering/01-ci-cd.md b/docs/docs/how-we-work/engineering/ci-cd.md similarity index 100% rename from docs/docs/contributors/engineering/01-ci-cd.md rename to docs/docs/how-we-work/engineering/ci-cd.md diff --git a/docs/docs/contributors/engineering/README.md b/docs/docs/how-we-work/engineering/engineering.md similarity index 100% rename from docs/docs/contributors/engineering/README.md rename to docs/docs/how-we-work/engineering/engineering.md diff --git a/docs/docs/contributors/engineering/02-qa.mdx b/docs/docs/how-we-work/engineering/qa.mdx similarity index 100% rename from docs/docs/contributors/engineering/02-qa.mdx rename to docs/docs/how-we-work/engineering/qa.mdx diff --git a/docs/docs/contributors/product/management.md b/docs/docs/how-we-work/project-management/project-management.md similarity index 90% rename from docs/docs/contributors/product/management.md rename to docs/docs/how-we-work/project-management/project-management.md index c231801c0..58af4a0d3 100644 --- a/docs/docs/contributors/product/management.md +++ b/docs/docs/how-we-work/project-management/project-management.md @@ -1,6 +1,5 @@ --- title: Project Management -slug: /product/management --- We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github to manage our roadmap and sprint Kanbans. @@ -58,3 +57,10 @@ We aim to always sprint on `tasks` that are a part of the [current roadmap](http - `Urgent bugs`: assign to an owner (or @engineers if you are not sure) && tag the current `sprint` & `milestone` - `All else`: assign the correct roadmap `label(s)` and owner (if any) + + +#### Request for help + +As a result, our feature prioritization can feel a bit black box at times. + +We'd appreciate high quality insights and volunteers for user interviews through [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq). diff --git a/docs/docs/how-we-work/strategy/strategy.md b/docs/docs/how-we-work/strategy/strategy.md new file mode 100644 index 000000000..09d9b9fb4 --- /dev/null +++ b/docs/docs/how-we-work/strategy/strategy.md @@ -0,0 +1,53 @@ +--- +title: Strategy +--- + +We only have 2 planning parameters: +- 10 year vision +- 2 week sprint +- Quarterly OKRs + +### Ideal Customer + +Our ideal customer is an AI enthusiast or business who has experienced some limitations with current AI solutions and is keen to find open source alternatives. + +### Problems + +Our ideal customer would use Jan to solve one of these problems. + +_Control_ + +- Control (e.g. preventing vendor lock-in) +- Stability (e.g. runs predictably every time) +- Local-use (e.g. for speed, or for airgapped environments) + +_Privacy_ + +- Data protection (e.g. personal data or company data) +- Privacy (e.g. nsfw) + +_Customisability_ + +- Tinkerability (e.g. ability to change model, experiment) +- Niche Models (e.g. fine-tuned, domain-specific models that outperform OpenAI) + +Sources: [^1] [^2] [^3] [^4] + +[^1]: [What are you guys doing that can't be done with ChatGPT?](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3) +[^2]: [What's your main interest in running a local LLM instead of an existing API?](https://www.reddit.com/r/LocalLLaMA/comments/1718a9o/whats_your_main_interest_in_running_a_local_llm/) +[^3]: [Ask HN: What's the best self-hosted/local alternative to GPT-4?](https://news.ycombinator.com/item?id=36138224) +[^4]: [LoRAs](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7mdz1i/?utm_source=share&utm_medium=web2x&context=3) + +### Solution + +Jan is a seamless user experience that runs on your personal computer, that glues the different pieces of the open source AI ecosystem to provide an alternative to OpenAI's closed platform. + +- We build a comprehensive, seamless platform that takes care of the technical chores across the stack required to run open source AI +- We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!) +- We provide open formats for packaging and distributing AI to run reproducibly across devices + + +## Prerequisites + +- [Figma](https://figma.com) +- [ScreenStudio](https://www.screen.studio/) diff --git a/docs/docs/how-we-work/website-docs/website-docs.md b/docs/docs/how-we-work/website-docs/website-docs.md new file mode 100644 index 000000000..a152c6dc9 --- /dev/null +++ b/docs/docs/how-we-work/website-docs/website-docs.md @@ -0,0 +1,3 @@ +--- +title: Website & Docs +--- \ No newline at end of file diff --git a/docs/docs/partners/become-a-partner.md b/docs/docs/partners/become-a-partner.md new file mode 100644 index 000000000..dce93e87a --- /dev/null +++ b/docs/docs/partners/become-a-partner.md @@ -0,0 +1,3 @@ +--- +title: Become a Partner +--- \ No newline at end of file diff --git a/docs/docs/team/team.md b/docs/docs/team/team.md index faf5697b2..7d5e07cfb 100644 --- a/docs/docs/team/team.md +++ b/docs/docs/team/team.md @@ -5,6 +5,23 @@ title: Who we are What's Jan the company about? We aim to build the cognitive framework for future robots +### Open Source + +Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it. + +- [Jan Framework](https://github.com/janhq/jan) (AGPLv3) +- [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework) +- [Nitro: run Local AI](https://github.com/janhq/nitro) (AGPLv3) + + +### Bootstrapped + +Jan is currently a bootstrapped startup. + +We balance technical invention with the search for a sustainable business model. Thus, we appreciate any business inquiries that can balance growth with cashflow. + +**We invite you to join us on our journey to find PMF**. Join our [Discord here](https://discord.gg/BnHRr3Q7Ms) + ## Our Team - Contributors diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index b26f2cdc6..b1217546d 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -275,9 +275,9 @@ const config = { }, { type: "docSidebar", - sidebarId: "partnerSidebar", + sidebarId: "ecosystemSidebar", position: "left", - label: "Partners", + label: "Ecosystem", }, { type: "docSidebar", diff --git a/docs/sidebars.js b/docs/sidebars.js index 31aa24784..91c8b9f85 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -34,12 +34,31 @@ const sidebars = { { type: "category", label: "How We Work", - link: { type: "doc", id: "contributors" }, + link: { type: "doc", id: "how-we-work" }, items: [ + "how-we-work/strategy/strategy", + "how-we-work/project-management/project-management", { - type: "autogenerated", - dirName: "contributors", + type: "category", + label: "Engineering", + link: { type: "doc", id: "how-we-work/engineering/engineering" }, + items: [ + "how-we-work/engineering/ci-cd", + "how-we-work/engineering/qa", + ], }, + "how-we-work/design/design", + { + type: "category", + label: "Engineering", + link: { type: "doc", id: "how-we-work/engineering/engineering" }, + items: [ + "how-we-work/engineering/ci-cd", + "how-we-work/engineering/qa", + ], + }, + "how-we-work/analytics/analytics", + "how-we-work/website-docs/website-docs", ], }, ], @@ -82,18 +101,6 @@ const sidebars = { // "server-suite/observability", // ], // }, - - { - type: "category", - label: "Integrations", - link: { type: "doc", id: "integrations" }, - items: [ - { - type: "autogenerated", - dirName: "integrations", - }, - ], - }, ], solutionSidebar: [ { @@ -130,7 +137,27 @@ const sidebars = { ], pricingSidebar: ["pricing/pricing"], - partnerSidebar: ["partners/partners"], + ecosystemSidebar: [ + "ecosystem/ecosystem", + { + type: "category", + label: "Partners", + link: { type: "doc", id: "partners/partners" }, + collapsible: true, + items: ["partners/become-a-partner"], + }, + { + type: "category", + label: "Integrations", + link: { type: "doc", id: "integrations" }, + items: [ + { + type: "autogenerated", + dirName: "integrations", + }, + ], + }, + ], guidesSidebar: [ { type: "autogenerated", diff --git a/docs/static/img/bladerunner.png b/docs/static/img/bladerunner.png new file mode 100644 index 000000000..be3c6c634 Binary files /dev/null and b/docs/static/img/bladerunner.png differ diff --git a/docs/static/img/c3po-anakin.jpeg b/docs/static/img/c3po-anakin.jpeg new file mode 100644 index 000000000..f64917411 Binary files /dev/null and b/docs/static/img/c3po-anakin.jpeg differ diff --git a/docs/static/img/star-wars-droids.png b/docs/static/img/star-wars-droids.png new file mode 100644 index 000000000..41819af98 Binary files /dev/null and b/docs/static/img/star-wars-droids.png differ