Scaffold 'About' Pages

This commit is contained in:
Daniel 2024-02-10 11:41:03 +08:00
parent 7c37bc63c1
commit 71f77c6e4a
20 changed files with 203 additions and 133 deletions

View File

@ -1,7 +1,7 @@
--- ---
title: About Jan title: About Jan
slug: /about 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: keywords:
[ [
Jan AI, 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 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. 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 ## Contact
### General Enquiries ### General Enquiries

View File

@ -1,3 +0,0 @@
---
title: How We Work
---

View File

@ -1,9 +0,0 @@
---
title: Product
slug: /product
---
## Prerequisites
- [Figma](https://figma.com)
- [ScreenStudio](https://www.screen.studio/)

24
docs/docs/how-we-work.md Normal file
View File

@ -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.

View File

@ -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.

View File

@ -0,0 +1,3 @@
---
title: Design
---

View File

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

View File

@ -1,6 +1,5 @@
--- ---
title: Project Management 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. 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` - `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) - `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).

View File

@ -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/)

View File

@ -0,0 +1,3 @@
---
title: Website & Docs
---

View File

@ -0,0 +1,3 @@
---
title: Become a Partner
---

View File

@ -5,6 +5,23 @@ title: Who we are
What's Jan the company about? What's Jan the company about?
We aim to build the cognitive framework for future robots 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 ## Our Team
- Contributors - Contributors

View File

@ -275,9 +275,9 @@ const config = {
}, },
{ {
type: "docSidebar", type: "docSidebar",
sidebarId: "partnerSidebar", sidebarId: "ecosystemSidebar",
position: "left", position: "left",
label: "Partners", label: "Ecosystem",
}, },
{ {
type: "docSidebar", type: "docSidebar",

View File

@ -34,12 +34,31 @@ const sidebars = {
{ {
type: "category", type: "category",
label: "How We Work", label: "How We Work",
link: { type: "doc", id: "contributors" }, link: { type: "doc", id: "how-we-work" },
items: [ items: [
"how-we-work/strategy/strategy",
"how-we-work/project-management/project-management",
{ {
type: "autogenerated", type: "category",
dirName: "contributors", 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", // "server-suite/observability",
// ], // ],
// }, // },
{
type: "category",
label: "Integrations",
link: { type: "doc", id: "integrations" },
items: [
{
type: "autogenerated",
dirName: "integrations",
},
],
},
], ],
solutionSidebar: [ solutionSidebar: [
{ {
@ -130,7 +137,27 @@ const sidebars = {
], ],
pricingSidebar: ["pricing/pricing"], 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: [ guidesSidebar: [
{ {
type: "autogenerated", type: "autogenerated",

BIN
docs/static/img/bladerunner.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 453 KiB

BIN
docs/static/img/c3po-anakin.jpeg vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 KiB

BIN
docs/static/img/star-wars-droids.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB