Merge pull request #5950 from menloresearch/rp/jan-docs-v2

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

.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-    "recommendations": [
-        "esbenp.prettier-vscode"
-    ]
-}

.vscode/settings.json

@@ -1,7 +0,0 @@
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true,
-  "[rust]": {
-    "editor.defaultFormatter": "rust-lang.rust-analyzer"
-  }
-}

docs/src/pages/platforms/_meta.json

@@ -1,9 +0,0 @@
-{
-  "-- Switcher": {
-    "type": "separator",
-    "title": "Switcher"
-  },
-  "index": {
-    "display": "hidden"
-  }
-}

docs/src/pages/platforms/index.mdx

@@ -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'
-
-<div className="text-center py-12">
-  <div className="mb-8">
-    <h1 className="text-4xl font-bold bg-gradient-to-r from-blue-600 to-purple-600 bg-clip-text text-transparent mb-4 py-2">
-      🚀 Coming Soon
-    </h1>
-    <p className="text-xl text-gray-600 dark:text-gray-300 max-w-2xl mx-auto">
-      We're working on the next stage of Jan - making our local assistant more powerful and available in more platforms.
-    </p>
-  </div>
-
-  <div className="grid grid-cols-1 md:grid-cols-3 gap-6 max-w-4xl mx-auto mb-12">
-    <div className="p-6 border border-gray-200 dark:border-gray-700 rounded-lg bg-gradient-to-br from-blue-50 to-indigo-50 dark:from-blue-900/20 dark:to-indigo-900/20">
-      <div className="text-3xl mb-3">🌐</div>
-      <h3 className="text-lg font-semibold mb-2">Jan Web</h3>
-      <p className="text-sm text-gray-600 dark:text-gray-400">
-        Access Jan directly from your browser with our powerful web interface
-      </p>
-    </div>
-
-    <div className="p-6 border border-gray-200 dark:border-gray-700 rounded-lg bg-gradient-to-br from-green-50 to-emerald-50 dark:from-green-900/20 dark:to-emerald-900/20">
-      <div className="text-3xl mb-3">📱</div>
-      <h3 className="text-lg font-semibold mb-2">Jan Mobile</h3>
-      <p className="text-sm text-gray-600 dark:text-gray-400">
-        Take Jan on the go with our native mobile applications
-      </p>
-    </div>
-
-    <div className="p-6 border border-gray-200 dark:border-gray-700 rounded-lg bg-gradient-to-br from-purple-50 to-pink-50 dark:from-purple-900/20 dark:to-pink-900/20">
-      <div className="text-3xl mb-3">⚡</div>
-      <h3 className="text-lg font-semibold mb-2">Jan Server</h3>
-      <p className="text-sm text-gray-600 dark:text-gray-400">
-        Integrate Jan's capabilities into your applications with our API
-      </p>
-    </div>
-  </div>
-
-  <Callout type="info">
-    **Stay Updated**: Follow our [GitHub repository](https://github.com/menloresearch/jan) and join our [Discord community](https://discord.com/invite/FTk2MvZwJH) for the latest updates on these exciting releases!
-  </Callout>
-
-  <div className="mt-12">
-    <h2 className="text-2xl font-semibold mb-6">What to Expect</h2>
-    <div className="text-left max-w-2xl mx-auto space-y-4">
-      <div className="flex items-start gap-3">
-        <span className="text-green-500 text-xl">✓</span>
-        <div>
-          <strong>Seamless Experience:</strong> Unified interface across all platforms
-        </div>
-      </div>
-      <div className="flex items-start gap-3">
-        <span className="text-green-500 text-xl">✓</span>
-        <div>
-          <strong>Privacy First:</strong> Same privacy-focused approach you trust
-        </div>
-      </div>
-      <div className="flex items-start gap-3">
-        <span className="text-green-500 text-xl">✓</span>
-        <div>
-          <strong>Developer Friendly:</strong> Robust APIs and comprehensive documentation
-        </div>
-      </div>
-    </div>
-  </div>
-</div>

website/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

website/README.md

@@ -0,0 +1,28 @@
+# Jan's Website
+
+This website is [built with Starlight](https://starlight.astro.build)
+
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed
+as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+If you want to add new pages, these can go in the `src/pages/` directory. Because of the topics plugin
+we are using ([starlight sidebar topics](https://starlight-sidebar-topics.netlify.app/docs/guides/excluded-pages/))
+you will need to exclude them from the sidebar by adding them to the exclude list in `astro.config.mjs`, e.g., `exclude: ['/example'],`.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `bun install`             | Installs dependencies                            |
+| `bun dev`             | Starts local dev server at `localhost:4321`      |
+| `bun build`           | Build your production site to `./dist/`          |
+| `bun preview`         | Preview your build locally, before deploying     |
+| `bun astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `bun astro -- --help` | Get help using the Astro CLI                     |

website/astro.config.mjs

@@ -0,0 +1,175 @@
+// @ts-check
+import { defineConfig } from 'astro/config'
+import starlight from '@astrojs/starlight'
+import starlightThemeRapide from 'starlight-theme-rapide'
+import starlightSidebarTopics from 'starlight-sidebar-topics'
+import mermaid from 'astro-mermaid'
+
+// https://astro.build/config
+export default defineConfig({
+  // Deploy to the new v2 subdomain
+  site: 'https://v2.jan.ai',
+  // No 'base' property is needed, as this will be deployed to the root of the subdomain.
+  integrations: [
+    mermaid({
+      theme: 'default',
+      autoTheme: true,
+    }),
+    starlight({
+      title: '👋 Jan',
+      favicon: 'jan2.png',
+      plugins: [
+        starlightThemeRapide(),
+        starlightSidebarTopics(
+          [
+            {
+              label: 'Jan Desktop',
+              link: '/',
+              icon: 'rocket',
+              items: [
+                {
+                  label: 'HOW TO',
+                  items: [
+                    {
+                      label: 'Install 👋 Jan',
+                      collapsed: false,
+                      autogenerate: { directory: 'jan/installation' },
+                    },
+                    { label: 'Start Chatting', slug: 'jan/threads' },
+                    {
+                      label: 'Use Jan Models',
+                      collapsed: true,
+                      autogenerate: { directory: 'jan/jan-models' },
+                    },
+                    { label: 'Assistants', slug: 'jan/assistants' },
+                  ],
+                },
+                {
+                  label: 'Cloud Providers',
+                  items: [
+                    { label: 'Anthropic', slug: 'jan/remote-models/anthropic' },
+                    { label: 'OpenAI', slug: 'jan/remote-models/openai' },
+                    { label: 'Gemini', slug: 'jan/remote-models/google' },
+                    {
+                      label: 'OpenRouter',
+                      slug: 'jan/remote-models/openrouter',
+                    },
+                    { label: 'Cohere', slug: 'jan/remote-models/cohere' },
+                    { label: 'Mistral', slug: 'jan/remote-models/mistralai' },
+                    { label: 'Groq', slug: 'jan/remote-models/groq' },
+                  ],
+                },
+                {
+                  label: 'EXPLANATION',
+                  items: [
+                    {
+                      label: 'Local AI Engine',
+                      slug: 'jan/explanation/llama-cpp',
+                    },
+                    {
+                      label: 'Model Parameters',
+                      slug: 'jan/explanation/model-parameters',
+                    },
+                  ],
+                },
+                {
+                  label: 'ADVANCED',
+                  items: [
+                    { label: 'Manage Models', slug: 'jan/manage-models' },
+                    { label: 'Model Context Protocol', slug: 'jan/mcp' },
+                    {
+                      label: 'MCP Examples',
+                      collapsed: true,
+                      items: [
+                        {
+                          label: 'Code Sandbox (E2B)',
+                          slug: 'jan/mcp-examples/data-analysis/e2b',
+                        },
+                        {
+                          label: 'Web Search with Exa',
+                          slug: 'jan/mcp-examples/search/exa',
+                        },
+                      ],
+                    },
+                  ],
+                },
+                {
+                  label: 'Local Server',
+                  items: [
+                    { label: 'Introduction', link: '/local-server/' },
+                    { label: 'Server Setup', slug: 'local-server/api-server' },
+                    {
+                      label: 'Jan Data Folder',
+                      slug: 'local-server/data-folder',
+                    },
+                    { label: 'Server Settings', slug: 'local-server/settings' },
+                    {
+                      label: 'Llama.cpp Server',
+                      slug: 'local-server/llama-cpp',
+                    },
+                    {
+                      label: 'Integrations',
+                      collapsed: true,
+                      autogenerate: { directory: 'local-server/integrations' },
+                    },
+                  ],
+                },
+                {
+                  label: 'REFERENCE',
+                  items: [
+                    { label: 'Settings', slug: 'jan/settings' },
+                    { label: 'Jan Data Folder', slug: 'jan/data-folder' },
+                    { label: 'Troubleshooting', slug: 'jan/troubleshooting' },
+                    { label: 'Privacy Policy', slug: 'jan/privacy' },
+                  ],
+                },
+              ],
+            },
+            {
+              label: 'Jan Mobile',
+              link: '/mobile/',
+              badge: { text: 'Coming Soon', variant: 'caution' },
+              icon: 'phone',
+              items: [{ label: 'Overview', slug: 'mobile' }],
+            },
+            {
+              label: 'Jan Server',
+              link: '/server/',
+              badge: { text: 'Coming Soon', variant: 'caution' },
+              icon: 'forward-slash',
+              items: [{ label: 'Overview', slug: 'server' }],
+            },
+          ],
+          {
+            exclude: [
+              '/prods',
+              '/api-reference',
+              '/products',
+              '/products/**/*',
+            ],
+          }
+        ),
+      ],
+      social: [
+        {
+          icon: 'github',
+          label: 'GitHub',
+          href: 'https://github.com/menloresearch/jan',
+        },
+        {
+          icon: 'x.com',
+          label: 'X',
+          href: 'https://twitter.com/jandotai',
+        },
+        {
+          icon: 'discord',
+          label: 'Discord',
+          href: 'https://discord.com/invite/FTk2MvZwJH',
+        },
+      ],
+      components: {
+        Header: './src/components/CustomNav.astro',
+      },
+    }),
+  ],
+})

website/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "website",
+  "type": "module",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@astrojs/starlight": "^0.35.1",
+    "@lorenzo_lewis/starlight-utils": "^0.3.2",
+    "astro": "^5.6.1",
+    "astro-mermaid": "^1.0.4",
+    "gsap": "^3.13.0",
+    "mermaid": "^11.9.0",
+    "phosphor-astro": "^2.1.0",
+    "sharp": "^0.34.3",
+    "starlight-openapi": "^0.19.1",
+    "starlight-sidebar-topics": "^0.6.0",
+    "starlight-theme-rapide": "^0.5.1",
+    "starlight-videos": "^0.3.0"
+  },
+  "packageManager": "yarn@1.22.22"
+}

website/public/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill-rule="evenodd" d="M81 36 64 0 47 36l-1 2-9-10a6 6 0 0 0-9 9l10 10h-2L0 64l36 17h2L28 91a6 6 0 1 0 9 9l9-10 1 2 17 36 17-36v-2l9 10a6 6 0 1 0 9-9l-9-9 2-1 36-17-36-17-2-1 9-9a6 6 0 1 0-9-9l-9 10v-2Zm-17 2-2 5c-4 8-11 15-19 19l-5 2 5 2c8 4 15 11 19 19l2 5 2-5c4-8 11-15 19-19l5-2-5-2c-8-4-15-11-19-19l-2-5Z" clip-rule="evenodd"/><path d="M118 19a6 6 0 0 0-9-9l-3 3a6 6 0 1 0 9 9l3-3Zm-96 4c-2 2-6 2-9 0l-3-3a6 6 0 1 1 9-9l3 3c3 2 3 6 0 9Zm0 82c-2-2-6-2-9 0l-3 3a6 6 0 1 0 9 9l3-3c3-2 3-6 0-9Zm96 4a6 6 0 0 1-9 9l-3-3a6 6 0 1 1 9-9l3 3Z"/><style>path{fill:#000}@media (prefers-color-scheme:dark){path{fill:#fff}}</style></svg>