This commit introduces a significant restructuring of the documentation deployment and content strategy to support a gradual migration from Nextra to Astro. - **New Astro Workflow (`jan-astro-docs.yml`)**: Implemented a new, separate GitHub Actions workflow to build and deploy the Astro site from the `/website` directory to a new subdomain (`v2.jan.ai`). This isolates the new site from the existing one, allowing for independent development and testing. - **Removed Combined Workflow**: Deleted the previous, more complex combined workflow (`jan-combined-docs.yml`) and its associated test scripts to simplify the deployment process and eliminate routing conflicts. - **Astro Config Update**: Simplified the Astro configuration (`astro.config.mjs`) by removing the conditional `base` path. The Astro site is now configured to deploy to the root of its own subdomain. - **Mirrored Content**: Recreated the entire `/products` section from the Astro site within the Nextra site at `/docs/src/pages/products`. This provides content parity and a consistent user experience on both platforms during the transition period. - **File Structure**: Established a clear, organized structure for platforms, models, and tools within the Nextra `products` directory. - **Nextra Sidebar Fix**: Implemented the correct `_meta.json` structure for the new products section. Created nested meta files to build a collapsible sidebar, fixing the UI bug that caused duplicated navigation items. - **"Coming Soon" Pages**: Added clear, concise "Coming Soon" and "In Development" banners and content for upcoming products like Jan V1, Mobile, Server, and native Tools, ensuring consistent messaging across both sites. - **.gitignore**: Updated the root `.gitignore` to properly exclude build artifacts, caches, and environment files for both the Nextra (`/docs`) and Astro (`/website`) projects. - **Repository Cleanup**: Removed temporary and unused files related to the previous combined deployment attempt. This new architecture provides a stable, predictable, and low-risk path for migrating our documentation to Astro while ensuring the current production site remains unaffected.
175 lines
5.8 KiB
JavaScript
175 lines
5.8 KiB
JavaScript
// @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: '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',
|
|
},
|
|
}),
|
|
],
|
|
})
|