diff --git a/.github/workflows/jan-astro-docs.yml b/.github/workflows/jan-astro-docs.yml new file mode 100644 index 000000000..b551d847d --- /dev/null +++ b/.github/workflows/jan-astro-docs.yml @@ -0,0 +1,98 @@ +name: Jan Astro Docs + +on: + push: + branches: + - dev + paths: + - 'website/**' + - '.github/workflows/jan-astro-docs.yml' + pull_request: + paths: + - 'website/**' + - '.github/workflows/jan-astro-docs.yml' + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + workflow_dispatch: + +jobs: + deploy: + name: Deploy to CloudFlare Pages + env: + CLOUDFLARE_PROJECT_NAME: astro-docs + runs-on: ubuntu-latest + permissions: + contents: write + deployments: write + pull-requests: write + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 20 + + - uses: oven-sh/setup-bun@v2 + + - name: Install jq + uses: dcarbone/install-jq-action@v2.0.1 + + - name: Fill env vars + continue-on-error: true + working-directory: website + run: | + env_example_file=".env.example" + touch .env + while IFS= read -r line || [[ -n "$line" ]]; do + if [[ "$line" == *"="* ]]; then + var_name=$(echo $line | cut -d '=' -f 1) + echo $var_name + var_value="$(jq -r --arg key "$var_name" '.[$key]' <<< "$SECRETS")" + echo "$var_name=$var_value" >> .env + fi + done < "$env_example_file" + env: + SECRETS: '${{ toJson(secrets) }}' + + - name: Install dependencies + working-directory: website + run: bun install + - name: Build website + working-directory: website + run: bun run build + + - name: copy redirects and headers + continue-on-error: true + working-directory: website + run: | + cp _redirects dist/_redirects + cp _headers dist/_headers + + - name: Publish to Cloudflare Pages PR Preview and Staging + if: github.event_name == 'pull_request' + uses: cloudflare/pages-action@v1 + with: + apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} + accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} + projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }} + directory: ./website/dist + # Optional: Enable this if you want to have GitHub Deployments triggered + gitHubToken: ${{ secrets.GITHUB_TOKEN }} + id: deployCloudflarePages + + - uses: mshick/add-pr-comment@v2 + if: github.event_name == 'pull_request' + with: + message: | + Preview URL Astro Docs: ${{ steps.deployCloudflarePages.outputs.url }} + + - name: Publish to Cloudflare Pages Production + if: (github.event_name == 'push' && github.ref == 'refs/heads/dev') || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/dev') + uses: cloudflare/pages-action@v1 + with: + apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} + accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} + projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }} + directory: ./website/dist + branch: main + # Optional: Enable this if you want to have GitHub Deployments triggered + gitHubToken: ${{ secrets.GITHUB_TOKEN }} diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 0f148de5e..000000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "recommendations": [ - "esbenp.prettier-vscode" - ] -} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 78bf4f0ab..000000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "editor.defaultFormatter": "esbenp.prettier-vscode", - "editor.formatOnSave": true, - "[rust]": { - "editor.defaultFormatter": "rust-lang.rust-analyzer" - } -} diff --git a/docs/src/pages/platforms/_meta.json b/docs/src/pages/platforms/_meta.json deleted file mode 100644 index bfee4c12e..000000000 --- a/docs/src/pages/platforms/_meta.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "-- Switcher": { - "type": "separator", - "title": "Switcher" - }, - "index": { - "display": "hidden" - } -} diff --git a/docs/src/pages/platforms/index.mdx b/docs/src/pages/platforms/index.mdx deleted file mode 100644 index 1ba0ff3a7..000000000 --- a/docs/src/pages/platforms/index.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Coming Soon -description: Exciting new features and platforms are on the way. Stay tuned for Jan Web, Jan Mobile, and our API Platform. -keywords: - [ - Jan, - Customizable Intelligence, LLM, - local AI, - privacy focus, - free and open source, - private and offline, - conversational AI, - no-subscription fee, - large language models, - coming soon, - Jan Web, - Jan Mobile, - API Platform, - ] ---- - -import { Callout } from 'nextra/components' - -
- We're working on the next stage of Jan - making our local assistant more powerful and available in more platforms. -
-- Access Jan directly from your browser with our powerful web interface -
-- Take Jan on the go with our native mobile applications -
-- Integrate Jan's capabilities into your applications with our API -
-| Release Version | +Target Date | +Status | +
|---|---|---|
| + v0.6.7 + Web Search + | +Released | +Live | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
| + v0.6.5 + Desktop Stability + | +Released | +Live | +
|
+
+
+
+
+ Improvements+
+
+ Bug Fixes+
+
+ Performance+
|
+ ||
| + v0.7.0 + Deep Research + | +January 2025 | +Building | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
| + v0.8.0 + Browser Automation + | +March 2025 | +Building | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
| + v0.9.0 + Mobile Launch + | +Q1 2025 | +Planned | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
| + v1.0.0 + Server Edition + | +Q2 2025 | +Planned | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
| + v1.1.0 + AI Agents + | +Q1 2026 | +Planned | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
| + v1.2.0 + Lucy Multimodal + | +Q2 2025 | +Planned | +
|
+
+
+
+
+ User Stories+
+
+ New Features+
+
+ Documentation+
|
+ ||
+Jan is moving from a local AI application to a complete full-stack AI solution that you can self-host. This includes models, +applications, and tools that delights users and help them solve their problems. +
+ +## What We're Building + +**Jan Factory (or Agent)** = Jan Models + Jan Application + Jan Tools + +Unlike other AI assistants that do specific tasks with one model or have many models with a myriad of solutions, Jan provides: +- Its own specialised models that are optimised at specific tasks like web-search, creative writing, and translation +- Applications that work across all of your devices in an integrated way +- Tools that actually get things done + +## Two Modes, One Experience + +### Local (Incognito) Mode + +Run AI models entirely on your device, giving you complete privacy with no internet required. + + + +### Cloud Mode + +Connect to more powerful models when needed - either self-hosted or via jan.ai. + + + +Users shouldn't need to understand models, APIs, or technical details. Just choose Local for privacy or Cloud for power. + +## Our Product Principles + +### 1) It Just Works + +1. Open Jan, start chatting +2. Onboarding is fully available but optional +3. Setting up an API key is optional +4. Selecting a local model is optional +5. Become a power user at your own pace, if you want to + +We handle the complexity. + +### 2) Cloud When Needed + +Start completely locally and own your AI models. Add cloud capabilities only when you choose to. + +### 3) Solve Problems, Not Settings + +We help users get to answers quickly answers, not configuration options. Power users can dig deeper, but it's never required. + +## Available on Every Device + +### Jan Desktop + +This is how Jan started and it has been available since day 1. Jan Desktop stives to be: + +> Your personal AI workstation that helps with our use cases and powers other devices. Run models locally right away +or bring an API key to connect to your favorite cloud-based models. + +**Key Features:** +- Runs models locally on your hardware +- GPU acceleration support +- Powers other devices via network connection +- Complete privacy and control +- Windows, macOS, and Linux support + +**Requirements:** +- Minimum 8GB RAM +- 10GB+ storage space +- Optional: NVIDIA GPU for acceleration + +### Jan Web + +**Status:** Beta Launch Soon + + + +Web-based version of 👋 Jan with no setup required. Same default cloud mode for mobile and desktop users. + +**Key Features:** +- No installation needed +- Instant access from any browser +- Automatic updates and maintenance +- Default cloud backend for mobile apps +- Team collaboration features + - Share prompts + - Share workflows + - Collaborate on threads + +**Pricing:** +- Free for everyone +- Pro: + - Access our latest models + - Access other cloud providers, no need to bring their API keys +- Enterprise: + - Self-host or we host it for you + - Active support and SLAs + - SSO + - Team featues + +### Jan Mobile + +**Status:** Coming Q4 2025 + +Connect to Desktop/Server, run local mode with Jan Nano or Lucy, same experience everywhere. + +Jan Mobile adapts to your situation: + +At Home, you can connect to your Jan Desktop over WiFi + + + +At Work, you can connect to your company Jan Server + + + +On the Go, you can run Jan Nano on your phone or talk to your favourite cloud-based model + + + +**Key Features:** +- iOS and Android support +- Three adaptive modes (Desktop, Server, Local) +- Voice-first interface +- Seamless device switching +- Jan Nano for on-device AI + +### Jan Server + +**Status:** Coming Q2 2025 + +Self-hosted solution for teams and enterprises. Your own private AI cloud. + +**Key Features:** +- Support for 5-500+ concurrent users +- Enterprise authentication (SSO, LDAP) +- Docker and Kubernetes deployment +- Admin dashboard +- Team knowledge sharing + +**Deployment Options:** +- Docker: Single command setup +- Kubernetes: Enterprise scale +- Bare metal: Maximum control + +## Jan Mobile: Three Modes, One Experience + +Jan Mobile brings the same AI experience to your phone. Connect to your desktop, your server, or run models locally. + +### How It Works + +Jan Mobile adapts to your situation: + +**At Home** - Connect to your Jan Desktop over WiFi +Your Phone → WiFi → Your Desktop → Response + +**At Work** - Connect to your company Jan Server +Your Phone → Internet → Company Server → Response + +**On the Go** - Run Jan Nano on your phone or talk to your favorite cloud-based model +Your Phone → Jan Nano (6GB) → Response + +No configuration needed. It just works. + +### Key Features + +- **Seamless Switching**: Move from home to office to airplane. One-click and Jan adapts immediately. +- **Voice First**: Talk to Jan naturally. Responses can be spoken too. +- **Sync Everything**: Conversations, settings, and preferences follow you across devices. + +### Privacy & Security + +**Your Data, Your Control** +- Local Mode: Everything stays on your phone +- Desktop Mode: Direct encrypted connection +- Server Mode: Your organization's policies apply + +**No Compromises** +- Biometric app lock +- Encrypted storage +- No cloud backups without permission +- Clear data anytime + +## What Makes Jan Different + +| Feature | +Other AI Assistants | +Jan | +
|---|---|---|
| Models | +Wrapper around Claude/GPT | +Our own models + You can own them | +
| Dual mode | +Your data on their servers | +Your data stays yours | +
| Deployment | +Cloud only | +Local, self-hosted, or cloud | +
| Cost | +Subscription forever | +Free locally, pay for cloud | +