diff --git a/website/PRODUCTS_PAGE_README.MD b/website/PRODUCTS_PAGE_README.MD new file mode 100644 index 000000000..e4a1188be --- /dev/null +++ b/website/PRODUCTS_PAGE_README.MD @@ -0,0 +1,306 @@ +# Jan Products Page - Retro-Tech Design System + +A futuristic products showcase page that combines the nostalgic aesthetics of RadioShack's electronic components with PostHog's modern data visualization approach. This creates a unique "retro-tech" visual language that feels both familiar and cutting-edge. + +## Design Philosophy + +### RadioShack + PostHog = Retro-Tech +- **RadioShack Heritage**: Circuit board patterns, electronic components, terminal interfaces, amber/green CRT colors +- **PostHog Influence**: Clean data cards, status indicators, system metrics, dashboard layouts +- **Result**: A cohesive aesthetic that makes AI products feel like sophisticated electronic equipment + +### Color Palette +```css +--retro-green: #00ff41 /* Matrix green, primary brand */ +--retro-amber: #ffb000 /* Classic terminal amber */ +--retro-blue: #00bfff /* Processing/loading states */ +--retro-red: #ff0040 /* Error/warning states */ +--retro-cyan: #00ffff /* Accent highlights */ +--retro-magenta: #ff00ff /* Special effects */ +``` + +## Architecture + +### File Structure +``` +jan/website/src/ +├── pages/ +│ └── prods.astro # Main products page +├── components/ +│ ├── CircuitBackground.astro # Animated circuit patterns +│ ├── StatusIndicator.astro # System status components +│ ├── RetroCard.astro # Terminal-style cards +│ └── FloatingNav.astro # Floating navigation menu +├── layouts/ +│ └── Layout.astro # Base layout with GSAP +└── styles/ + └── retro-effects.css # Advanced visual effects +``` + +### Component Hierarchy +``` +Layout +└── Products Page + ├── FloatingNav (right-side navigation) + ├── Hero Section + │ └── CircuitBackground (animated) + ├── Table of Contents + ├── Models Section + │ └── RetroCard (circuit variant) + ├── Platforms Section + │ └── RetroCard (data/system variants) + ├── Tools Section + │ └── RetroCard (terminal variant) + └── Integration Section +``` + +## Components Deep Dive + +### CircuitBackground.astro +Creates animated circuit board patterns with electronic components. + +**Props:** +- `variant`: 'subtle' | 'prominent' | 'animated' +- `color`: 'green' | 'amber' | 'blue' | 'multi' +- `density`: 'low' | 'medium' | 'high' +- `animated`: boolean +- `opacity`: number (0-1) + +**Features:** +- Procedural circuit patterns +- Animated electronic components (LEDs, resistors, capacitors) +- Flowing data lines +- Responsive grid scaling + +### StatusIndicator.astro +Terminal-style system status indicators with pulsing animations. + +**Props:** +- `status`: 'active' | 'warning' | 'success' | 'error' | 'idle' +- `label`: string +- `pulse`: boolean +- `size`: 'small' | 'medium' | 'large' + +**Features:** +- Animated status dots with glow effects +- Color-coded status states +- Accessibility compliant +- Reduced motion support + +### RetroCard.astro +Terminal-inspired cards with scanlines, CRT effects, and interactive animations. + +**Props:** +- `variant`: 'terminal' | 'circuit' | 'data' | 'system' +- `color`: 'green' | 'amber' | 'blue' | 'red' | 'multi' +- `size`: 'small' | 'medium' | 'large' +- `glitch`: boolean +- `scanlines`: boolean +- `glow`: boolean +- `interactive`: boolean +- `status`: 'online' | 'offline' | 'error' | 'warning' | 'processing' + +**Features:** +- CRT monitor bezels with power indicators +- Animated scanlines and glitch effects +- Terminal-style headers with traffic light controls +- Interactive hover states with 3D transforms +- Corner brackets for retro-futuristic framing + +### FloatingNav.astro +Floating navigation with terminal interface and system monitoring. + +**Props:** +- `sections`: Array of navigation items with icons and status +- `position`: 'left' | 'right' +- `theme`: 'dark' | 'matrix' | 'circuit' +- `compact`: boolean + +**Features:** +- Terminal-style command prompt +- Real-time system status indicators +- Animated progress bars +- Circuit connection lines +- Smooth scrolling with GSAP integration + +## Animations & Effects + +### GSAP Integration +The page uses GSAP (GreenSock Animation Platform) for sophisticated animations: + +**Timeline Animations:** +- Hero section entrance with staggered reveals +- Section headers with typewriter effects +- Card appearances with 3D transforms + +**Scroll Triggers:** +- Elements animate into view as user scrolls +- Parallax effects on background elements +- Progressive content revelation + +**Interactive Animations:** +- Magnetic cursor effects on cards +- 3D hover transformations +- Ripple effects on clicks + +### CSS-Only Effects +Enhanced with pure CSS animations for performance: + +**Visual Effects:** +- CRT scanlines and monitor bezels +- Matrix-style character rain +- Glitch text distortions +- Neon glow and pulsing lights + +**Component Animations:** +- Electronic component blinking (LEDs) +- Data stream flowing effects +- Circuit trace pulsing +- Status indicator breathing + +## Performance Optimizations + +### Lazy Loading +- GSAP libraries loaded from CDN +- Animations initialized after DOM ready +- Circuit patterns use CSS transforms for GPU acceleration + +### Reduced Motion Support +```css +@media (prefers-reduced-motion: reduce) { + /* All animations disabled for accessibility */ +} +``` + +### Mobile Optimizations +- Responsive grid layouts +- Touch-friendly interactive elements +- Optimized animation performance +- Reduced visual effects on smaller screens + +## Accessibility Features + +### WCAG Compliance +- High contrast mode support +- Focus indicators for keyboard navigation +- Screen reader friendly markup +- Semantic HTML structure + +### Keyboard Navigation +- Tab order follows logical flow +- Escape key closes floating navigation +- Arrow keys for menu navigation +- Enter/Space for activation + +### Color Accessibility +- Sufficient contrast ratios maintained +- Status information not solely color-dependent +- Alternative text for decorative elements + +## Customization Guide + +### Adding New Sections +1. Add section to main page +2. Update FloatingNav sections array +3. Add corresponding GSAP animations +4. Update TOC links + +### Creating New Card Variants +```astro + + + +``` + +### Custom Circuit Patterns +```astro + +``` + +### Color Theme Customization +Override CSS custom properties: +```css +:root { + --retro-green: #your-color; + --retro-amber: #your-color; + /* etc. */ +} +``` + +## Dependencies + +### Required +- Astro ^5.6.1 +- GSAP (loaded from CDN) +- JetBrains Mono font + +### Optional Enhancements +- Sharp for image optimization +- Additional GSAP plugins for advanced effects + +## Browser Support + +### Fully Supported +- Chrome 88+ +- Firefox 85+ +- Safari 14+ +- Edge 88+ + +### Graceful Degradation +- Older browsers receive static layout +- CSS fallbacks for unsupported features +- Progressive enhancement approach + +## Development Commands + +```bash +# Start development server +npm run dev + +# Build for production +npm run build + +# Preview production build +npm run preview +``` + +## Future Enhancements + +### Planned Features +- Sound effects for interactions +- More electronic component animations +- Additional card variants +- Theme switching capability +- Advanced glitch effects + +### Performance Improvements +- WebGL circuit backgrounds +- Intersection Observer for animations +- Service worker for offline support +- Image lazy loading optimization + +## Contributing + +When adding new components or effects: + +1. Follow the retro-tech design language +2. Ensure accessibility compliance +3. Add reduced motion alternatives +4. Test on multiple devices +5. Document new props and features + +--- + +*Created with ❤️ and a healthy dose of 80s nostalgia* diff --git a/website/PRODUCTS_PAGE_README.md b/website/PRODUCTS_PAGE_README.md new file mode 100644 index 000000000..54299c01b --- /dev/null +++ b/website/PRODUCTS_PAGE_README.md @@ -0,0 +1,306 @@ +# Jan Products Page - Retro-Tech Design System + +A futuristic products showcase page that combines the nostalgic aesthetics of RadioShack's electronic components with PostHog's modern data visualization approach. This creates a unique "retro-tech" visual language that feels both familiar and cutting-edge. + +## Design Philosophy + +### RadioShack + PostHog = Retro-Tech +- **RadioShack Heritage**: Circuit board patterns, electronic components, terminal interfaces, amber/green CRT colors +- **PostHog Influence**: Clean data cards, status indicators, system metrics, dashboard layouts +- **Result**: A cohesive aesthetic that makes AI products feel like sophisticated electronic equipment + +### Color Palette +```css +--retro-green: #00ff41 /* Matrix green, primary brand */ +--retro-amber: #ffb000 /* Classic terminal amber */ +--retro-blue: #00bfff /* Processing/loading states */ +--retro-red: #ff0040 /* Error/warning states */ +--retro-cyan: #00ffff /* Accent highlights */ +--retro-magenta: #ff00ff /* Special effects */ +``` + +## Architecture + +### File Structure +``` +jan/website/src/ +├── pages/ +│ └── prods.astro # Main products page +├── components/ +│ ├── CircuitBackground.astro # Animated circuit patterns +│ ├── StatusIndicator.astro # System status components +│ ├── RetroCard.astro # Terminal-style cards +│ └── FloatingNav.astro # Floating navigation menu +├── layouts/ +│ └── Layout.astro # Base layout with GSAP +└── styles/ + └── retro-effects.css # Advanced visual effects +``` + +### Component Hierarchy +``` +Layout +└── Products Page + ├── FloatingNav (right-side navigation) + ├── Hero Section + │ └── CircuitBackground (animated) + ├── Table of Contents + ├── Models Section + │ └── RetroCard (circuit variant) + ├── Platforms Section + │ └── RetroCard (data/system variants) + ├── Tools Section + │ └── RetroCard (terminal variant) + └── Integration Section +``` + +## Components Deep Dive + +### CircuitBackground.astro +Creates animated circuit board patterns with electronic components. + +**Props:** +- `variant`: 'subtle' | 'prominent' | 'animated' +- `color`: 'green' | 'amber' | 'blue' | 'multi' +- `density`: 'low' | 'medium' | 'high' +- `animated`: boolean +- `opacity`: number (0-1) + +**Features:** +- Procedural circuit patterns +- Animated electronic components (LEDs, resistors, capacitors) +- Flowing data lines +- Responsive grid scaling + +### StatusIndicator.astro +Terminal-style system status indicators with pulsing animations. + +**Props:** +- `status`: 'active' | 'warning' | 'success' | 'error' | 'idle' +- `label`: string +- `pulse`: boolean +- `size`: 'small' | 'medium' | 'large' + +**Features:** +- Animated status dots with glow effects +- Color-coded status states +- Accessibility compliant +- Reduced motion support + +### RetroCard.astro +Terminal-inspired cards with scanlines, CRT effects, and interactive animations. + +**Props:** +- `variant`: 'terminal' | 'circuit' | 'data' | 'system' +- `color`: 'green' | 'amber' | 'blue' | 'red' | 'multi' +- `size`: 'small' | 'medium' | 'large' +- `glitch`: boolean +- `scanlines`: boolean +- `glow`: boolean +- `interactive`: boolean +- `status`: 'online' | 'offline' | 'error' | 'warning' | 'processing' + +**Features:** +- CRT monitor bezels with power indicators +- Animated scanlines and glitch effects +- Terminal-style headers with traffic light controls +- Interactive hover states with 3D transforms +- Corner brackets for retro-futuristic framing + +### FloatingNav.astro +Floating navigation with terminal interface and system monitoring. + +**Props:** +- `sections`: Array of navigation items with icons and status +- `position`: 'left' | 'right' +- `theme`: 'dark' | 'matrix' | 'circuit' +- `compact`: boolean + +**Features:** +- Terminal-style command prompt +- Real-time system status indicators +- Animated progress bars +- Circuit connection lines +- Smooth scrolling with GSAP integration + +## Animations & Effects + +### GSAP Integration +The page uses GSAP (GreenSock Animation Platform) for sophisticated animations: + +**Timeline Animations:** +- Hero section entrance with staggered reveals +- Section headers with typewriter effects +- Card appearances with 3D transforms + +**Scroll Triggers:** +- Elements animate into view as user scrolls +- Parallax effects on background elements +- Progressive content revelation + +**Interactive Animations:** +- Magnetic cursor effects on cards +- 3D hover transformations +- Ripple effects on clicks + +### CSS-Only Effects +Enhanced with pure CSS animations for performance: + +**Visual Effects:** +- CRT scanlines and monitor bezels +- Matrix-style character rain +- Glitch text distortions +- Neon glow and pulsing lights + +**Component Animations:** +- Electronic component blinking (LEDs) +- Data stream flowing effects +- Circuit trace pulsing +- Status indicator breathing + +## Performance Optimizations + +### Lazy Loading +- GSAP libraries loaded from CDN +- Animations initialized after DOM ready +- Circuit patterns use CSS transforms for GPU acceleration + +### Reduced Motion Support +```css +@media (prefers-reduced-motion: reduce) { + /* All animations disabled for accessibility */ +} +``` + +### Mobile Optimizations +- Responsive grid layouts +- Touch-friendly interactive elements +- Optimized animation performance +- Reduced visual effects on smaller screens + +## Accessibility Features + +### WCAG Compliance +- High contrast mode support +- Focus indicators for keyboard navigation +- Screen reader friendly markup +- Semantic HTML structure + +### Keyboard Navigation +- Tab order follows logical flow +- Escape key closes floating navigation +- Arrow keys for menu navigation +- Enter/Space for activation + +### Color Accessibility +- Sufficient contrast ratios maintained +- Status information not solely color-dependent +- Alternative text for decorative elements + +## Customization Guide + +### Adding New Sections +1. Add section to main page +2. Update FloatingNav sections array +3. Add corresponding GSAP animations +4. Update TOC links + +### Creating New Card Variants +```astro + + + +``` + +### Custom Circuit Patterns +```astro + +``` + +### Color Theme Customization +Override CSS custom properties: +```css +:root { + --retro-green: #your-color; + --retro-amber: #your-color; + /* etc. */ +} +``` + +## Dependencies + +### Required +- Astro ^5.6.1 +- GSAP (loaded from CDN) +- JetBrains Mono font + +### Optional Enhancements +- Sharp for image optimization +- Additional GSAP plugins for advanced effects + +## Browser Support + +### Fully Supported +- Chrome 88+ +- Firefox 85+ +- Safari 14+ +- Edge 88+ + +### Graceful Degradation +- Older browsers receive static layout +- CSS fallbacks for unsupported features +- Progressive enhancement approach + +## Development Commands + +```bash +# Start development server +npm run dev + +# Build for production +npm run build + +# Preview production build +npm run preview +``` + +## Future Enhancements + +### Planned Features +- Sound effects for interactions +- More electronic component animations +- Additional card variants +- Theme switching capability +- Advanced glitch effects + +### Performance Improvements +- WebGL circuit backgrounds +- Intersection Observer for animations +- Service worker for offline support +- Image lazy loading optimization + +## Contributing + +When adding new components or effects: + +1. Follow the retro-tech design language +2. Ensure accessibility compliance +3. Add reduced motion alternatives +4. Test on multiple devices +5. Document new props and features + +--- + +*Created with ❤️ and a healthy dose of 80s nostalgia* \ No newline at end of file diff --git a/website/README.md b/website/README.md index 746f55b45..cec200784 100644 --- a/website/README.md +++ b/website/README.md @@ -1,41 +1,19 @@ -# Starlight Starter Kit: Basics +# Jan's Website -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) +This website is [built with Starlight](https://starlight.astro.build) -``` -bun create astro@latest -- --template starlight -``` -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs) - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! - -## 🚀 Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: - -``` -. -├── public/ -├── src/ -│ ├── assets/ -│ ├── content/ -│ │ └── docs/ -│ └── content.config.ts -├── astro.config.mjs -├── package.json -└── tsconfig.json -``` - -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. +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: @@ -48,7 +26,3 @@ All commands are run from the root of the project, from a terminal: | `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 | - -## 👀 Want to learn more? - -Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). diff --git a/website/astro.config.mjs b/website/astro.config.mjs index 97ac22f69..a4a2e5211 100644 --- a/website/astro.config.mjs +++ b/website/astro.config.mjs @@ -169,7 +169,7 @@ export default defineConfig({ }, ], { - exclude: ['/example'], + exclude: ['/prods'], topics: { university: [ '/university/getting-started/what-is-jan', diff --git a/website/package.json b/website/package.json index 3b409199b..4b936cd56 100644 --- a/website/package.json +++ b/website/package.json @@ -12,9 +12,11 @@ "dependencies": { "@astrojs/starlight": "^0.35.1", "astro": "^5.6.1", + "gsap": "^3.13.0", + "phosphor-astro": "^2.1.0", "sharp": "^0.34.2", "starlight-sidebar-topics": "^0.6.0", "starlight-theme-rapide": "^0.5.1", "starlight-videos": "^0.3.0" } -} \ No newline at end of file +} diff --git a/website/src/components/CircuitBackground.astro b/website/src/components/CircuitBackground.astro new file mode 100644 index 000000000..8f94ebafb --- /dev/null +++ b/website/src/components/CircuitBackground.astro @@ -0,0 +1,366 @@ +--- +export interface Props { + variant?: 'subtle' | 'prominent' | 'animated'; + color?: 'green' | 'amber' | 'blue' | 'multi'; + density?: 'low' | 'medium' | 'high'; + animated?: boolean; + opacity?: number; +} + +const { + variant = 'subtle', + color = 'green', + density = 'medium', + animated = true, + opacity = 0.1 +} = Astro.props; + +const colorSchemes = { + green: { + primary: '#00ff41', + secondary: '#00cc33', + accent: '#008822' + }, + amber: { + primary: '#ffb000', + secondary: '#ff9500', + accent: '#cc7700' + }, + blue: { + primary: '#00bfff', + secondary: '#0099cc', + accent: '#007799' + }, + multi: { + primary: '#00ff41', + secondary: '#ffb000', + accent: '#00bfff' + } +}; + +const colors = colorSchemes[color]; + +const densitySettings = { + low: { size: 80, nodes: 6 }, + medium: { size: 50, nodes: 8 }, + high: { size: 30, nodes: 12 } +}; + +const settings = densitySettings[density]; +--- + +
+ + +
+ + +
+ + +
+
+
+
+
+
+
+ + +
+
+ + diff --git a/website/src/components/FloatingNav.astro b/website/src/components/FloatingNav.astro new file mode 100644 index 000000000..86bd47b14 --- /dev/null +++ b/website/src/components/FloatingNav.astro @@ -0,0 +1,735 @@ +--- +export interface Props { + sections?: Array<{ + id: string; + label: string; + icon: string; + status?: 'active' | 'inactive' | 'processing'; + }>; + position?: 'left' | 'right'; + theme?: 'dark' | 'matrix' | 'circuit'; + compact?: boolean; +} + +const { + sections = [ + { id: 'models', label: 'Models', icon: '🧠', status: 'active' }, + { id: 'platforms', label: 'Platforms', icon: '💻', status: 'active' }, + { id: 'tools', label: 'Tools', icon: '🔧', status: 'processing' } + ], + position = 'right', + theme = 'matrix', + compact = false +} = Astro.props; + +const navId = `floating-nav-${Math.random().toString(36).substr(2, 9)}`; +--- + +
+ + + + + + + + +
+ + + + diff --git a/website/src/components/RetroCard.astro b/website/src/components/RetroCard.astro new file mode 100644 index 000000000..0f8ab56a8 --- /dev/null +++ b/website/src/components/RetroCard.astro @@ -0,0 +1,601 @@ +--- +export interface Props { + variant?: 'terminal' | 'circuit' | 'data' | 'system'; + color?: 'green' | 'amber' | 'blue' | 'red' | 'multi'; + size?: 'small' | 'medium' | 'large'; + glitch?: boolean; + scanlines?: boolean; + glow?: boolean; + interactive?: boolean; + status?: 'online' | 'offline' | 'error' | 'warning' | 'processing'; + title?: string; + subtitle?: string; + className?: string; +} + +const { + variant = 'terminal', + color = 'green', + size = 'medium', + glitch = false, + scanlines = true, + glow = true, + interactive = true, + status = 'online', + title, + subtitle, + className = '' +} = Astro.props; + +const colorSchemes = { + green: { + primary: '#00ff41', + secondary: '#00cc33', + bg: 'rgba(0, 255, 65, 0.05)', + border: '#00ff41', + glow: 'rgba(0, 255, 65, 0.3)' + }, + amber: { + primary: '#ffb000', + secondary: '#ff9500', + bg: 'rgba(255, 176, 0, 0.05)', + border: '#ffb000', + glow: 'rgba(255, 176, 0, 0.3)' + }, + blue: { + primary: '#00bfff', + secondary: '#0099cc', + bg: 'rgba(0, 191, 255, 0.05)', + border: '#00bfff', + glow: 'rgba(0, 191, 255, 0.3)' + }, + red: { + primary: '#ff0040', + secondary: '#cc0033', + bg: 'rgba(255, 0, 64, 0.05)', + border: '#ff0040', + glow: 'rgba(255, 0, 64, 0.3)' + }, + multi: { + primary: '#00ff41', + secondary: '#ffb000', + bg: 'linear-gradient(135deg, rgba(0, 255, 65, 0.05), rgba(255, 176, 0, 0.05))', + border: '#00ff41', + glow: 'rgba(0, 255, 65, 0.3)' + } +}; + +const scheme = colorSchemes[color]; +const cardId = `retro-card-${Math.random().toString(36).substr(2, 9)}`; +--- + +
+ +
+
+
+
+
+
+ + {title && ( +
+ {title} + {subtitle && {subtitle}} +
+ )} + +
+
+ {status.toUpperCase()} +
+
+ + +
+ +
+ + + {scanlines && ( +
+ )} + + +
+ + +
+
+
+
+
+ + + + diff --git a/website/src/components/StatusIndicator.astro b/website/src/components/StatusIndicator.astro new file mode 100644 index 000000000..f60b23454 --- /dev/null +++ b/website/src/components/StatusIndicator.astro @@ -0,0 +1,147 @@ +--- +export interface Props { + status: 'active' | 'warning' | 'success' | 'error' | 'idle'; + label: string; + pulse?: boolean; + size?: 'small' | 'medium' | 'large'; +} + +const { status, label, pulse = true, size = 'medium' } = Astro.props; + +const statusColors = { + active: '#00ff41', + warning: '#ffb000', + success: '#00ff41', + error: '#ff0040', + idle: '#888888' +}; + +const statusColor = statusColors[status]; +--- + +
+
+ {label} +
+ + diff --git a/website/src/content/docs/jan/assistants.mdx b/website/src/content/docs/jan/assistants.mdx index 9e0bada5b..3cc553cb3 100644 --- a/website/src/content/docs/jan/assistants.mdx +++ b/website/src/content/docs/jan/assistants.mdx @@ -26,7 +26,7 @@ which can help guide how the AI model should behave and respond to your inputs. assistants, and customize their instructions and settings from the Assistants tab. ![The Assistants management page, where you can view, add, edit, or delete assistants. Each assistant has a name, -description, and can be customized for different tasks.](~/assets/assistants-ui-overview.png) +description, and can be customized for different tasks.](../../../assets/assistants-ui-overview.png) To find the Assistants tab: @@ -76,18 +76,18 @@ Provide examples when explaining complex topics. You can quickly switch between assistants, or create and edit them, directly from the Chat screen using the assistant dropdown menu at the top: -![Assistant Dropdown](~/assets/assistant-dropdown-updated.png) +![Assistant Dropdown](../../../assets/assistant-dropdown-updated.png) - Click the assistant's name (e.g., "Travel Planner") at the top of the Chat screen to open the dropdown menu. - The dropdown lists all of your assistants. Click on any of the assistants available to switch to it for the current chat session. - To create a new assistant, select **Create Assistant** at the bottom of the dropdown. This opens the Add Assistant dialog: -![Add Assistant Dialog](~/assets/assistant-add-dialog.png) +![Add Assistant Dialog](../../../assets/assistant-add-dialog.png) - To edit an existing assistant, click the gear (⚙️) icon next to its name in the dropdown. This opens the Edit Assistant dialog: -![Edit Assistant Dialog](~/assets/assistant-edit-dialog.png) +![Edit Assistant Dialog](../../../assets/assistant-edit-dialog.png) ### Add/Edit Assistant Dialogs - Set an (optional) emoji and name for your assistant. diff --git a/website/src/content/docs/jan/data-folder.mdx b/website/src/content/docs/jan/data-folder.mdx index 629b2e2b8..a1a404a5a 100644 --- a/website/src/content/docs/jan/data-folder.mdx +++ b/website/src/content/docs/jan/data-folder.mdx @@ -31,7 +31,7 @@ Via Jan: 2. Click
-![Open Jan Data Folder](~/assets/settings-11.png) +![Open Jan Data Folder](../../../assets/settings-11.png)
Via Terminal: diff --git a/website/src/content/docs/jan/explanation/llama-cpp.mdx b/website/src/content/docs/jan/explanation/llama-cpp.mdx index 7f4a49c51..58f0e82bf 100644 --- a/website/src/content/docs/jan/explanation/llama-cpp.mdx +++ b/website/src/content/docs/jan/explanation/llama-cpp.mdx @@ -43,7 +43,7 @@ Originally created by Georgi Gerganov, llama.cpp is designed to run large langua Find llama.cpp settings at **Settings** () > **Local Engine** > **llama.cpp**: -![llama.cpp](~/assets/llama.cpp-01-updated.png) +![llama.cpp](../../../../assets/llama.cpp-01-updated.png)
-![Clear Logs](~/assets/settings-09.png) +![Clear Logs](../../../assets/settings-09.png)
@@ -145,7 +145,7 @@ Jan stores your data locally in your own filesystem in a universal file format. At **Jan Data Folder**, click icon to open Jan application's folder:
-![Open Jan Data Folder](~/assets/settings-11.png) +![Open Jan Data Folder](../../../assets/settings-11.png)
**2. Edit Jan Data Folder** @@ -161,7 +161,7 @@ An app restart will be required afterward. 4. Click **Yes, Proceed**
-![Edit Jan Data Folder](~/assets/settings-12.png) +![Edit Jan Data Folder](../../../assets/settings-12.png)
### HTTPs Proxy @@ -184,7 +184,7 @@ Where: - ``: The port number for the proxy server
-![HTTPs Proxy](~/assets/settings-13.png) +![HTTPs Proxy](../../../assets/settings-13.png)
**Ignore SSL Certificates** @@ -199,7 +199,7 @@ Only enable this option if you trust your network environment.
-![Ignore SSL Certificates](~/assets/settings-14.png) +![Ignore SSL Certificates](../../../assets/settings-14.png)
@@ -218,7 +218,7 @@ Only use factory reset if: To begin the process: 1. At **Reset to Factory Settings**, click **Reset** button
-![Jan Quick Ask](~/assets/settings-17.png) +![Jan Quick Ask](../../../assets/settings-17.png)
2. In the confirmation dialog: - Type the word **RESET** to confirm @@ -226,5 +226,5 @@ To begin the process: - Click **Reset Now** 3. App restart is required upon confirmation
-![Jan Quick Ask](~/assets/settings-18.png) +![Jan Quick Ask](../../../assets/settings-18.png)
diff --git a/website/src/content/docs/jan/threads.mdx b/website/src/content/docs/jan/threads.mdx index 0c02a99e0..d7e2a2bd5 100644 --- a/website/src/content/docs/jan/threads.mdx +++ b/website/src/content/docs/jan/threads.mdx @@ -15,8 +15,7 @@ keywords: ] --- - -# Start Chatting +import { Aside } from '@astrojs/starlight/components';
    @@ -35,36 +34,36 @@ Jan requires a model to chat. Download one from the Hub: 3. Select one matching your hardware specs 4. Click **Download** -![Download a Model](~/assets/model-management-01.png) +![Download a Model](../../../assets/model-management-01.png) -
@@ -79,32 +78,32 @@ Jan organizes conversations into threads for easy tracking and revisiting. - **Favorites**: Pin important threads for quick access - **Recents**: Access recently used threads -![Favorites and Recents](~/assets/threads-favorites-and-recents-updated.png) +![Favorites and Recents](../../../assets/threads-favorites-and-recents-updated.png) ### Edit Chat Titles 1. Hover over a conversation in the sidebar -2. Click **three dots** () icon -3. Click **Rename** +2. Click the **three dots** icon +3. Click **Rename** 4. Enter new title and save -![Context Menu](~/assets/threads-context-menu-updated.png) +![Context Menu](../../../assets/threads-context-menu-updated.png) ### Delete Threads -