feat: replace Starlight docs with simple HTML product website
- Removed docs/ (Starlight) - Added www/ with pure HTML/CSS/JS landing page - Product website with features, how it works, get started - Basic HTML documentation pages (installation, quick start, AI providers) - Dockerfile.docs now serves static files from www/ - Updated README and AGENTS.md
This commit is contained in:
lotherk
138
www/docs/ai-providers.html
Normal file
138
www/docs/ai-providers.html
Normal file
@@ -0,0 +1,138 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>AI Providers - DearDiary</title>
|
||||
<link rel="stylesheet" href="../css/styles.css">
|
||||
<link rel="stylesheet" href="../css/docs.css">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar">
|
||||
<div class="nav-container">
|
||||
<a href="../" class="logo">
|
||||
<svg width="32" height="32" viewBox="0 0 100 100"><defs><linearGradient id="g" x1="0%" y1="0%" x2="100%" y2="100%"><stop offset="0%" style="stop-color:#6d28d9"/><stop offset="100%" style="stop-color:#4c1d95"/></linearGradient></defs><rect width="100" height="100" rx="20" fill="url(#g)"/><path d="M25 25 L75 25 L75 80 L25 80 Z" fill="none" stroke="white" stroke-width="3"/></svg>
|
||||
DearDiary
|
||||
</a>
|
||||
<div class="nav-links">
|
||||
<a href="../">Home</a>
|
||||
<a href="../docs/">Docs</a>
|
||||
<a href="https://github.com/lotherk/deardiary" target="_blank">GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="docs-layout">
|
||||
<aside class="docs-sidebar">
|
||||
<div class="sidebar-section">
|
||||
<h3>Getting Started</h3>
|
||||
<a href="installation.html">Installation</a>
|
||||
<a href="quick-start.html">Quick Start</a>
|
||||
<a href="configuration.html">Configuration</a>
|
||||
</div>
|
||||
<div class="sidebar-section">
|
||||
<h3>Features</h3>
|
||||
<a href="events.html">Events</a>
|
||||
<a href="diary-pages.html">Diary Pages</a>
|
||||
<a href="ai-providers.html" class="active">AI Providers</a>
|
||||
<a href="search.html">Search</a>
|
||||
<a href="export-import.html">Export & Import</a>
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
<main class="docs-content">
|
||||
<h1>AI Providers</h1>
|
||||
|
||||
<p>DearDiary supports multiple AI providers for diary generation. Choose the one that best fits your needs.</p>
|
||||
|
||||
<h2>Supported Providers</h2>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Provider</th>
|
||||
<th>Default Model</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Groq</strong> (Recommended)</td>
|
||||
<td>llama-3.3-70b-versatile</td>
|
||||
<td>Cloud</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OpenAI</td>
|
||||
<td>gpt-4o</td>
|
||||
<td>Cloud</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Anthropic</td>
|
||||
<td>claude-3-5-sonnet-latest</td>
|
||||
<td>Cloud</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ollama</td>
|
||||
<td>varies</td>
|
||||
<td>Local</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>LM Studio</td>
|
||||
<td>varies</td>
|
||||
<td>Local</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2>Groq (Recommended)</h2>
|
||||
<p>Fast inference with a free tier available.</p>
|
||||
<ol>
|
||||
<li>Get an API key from <a href="https://console.groq.com" target="_blank">console.groq.com</a></li>
|
||||
<li>Enter the API key in Settings</li>
|
||||
<li>Select Groq as your provider</li>
|
||||
<li>Test connection and save</li>
|
||||
</ol>
|
||||
|
||||
<h2>OpenAI</h2>
|
||||
<ol>
|
||||
<li>Get an API key from <a href="https://platform.openai.com" target="_blank">platform.openai.com</a></li>
|
||||
<li>Optionally select a specific model:
|
||||
<ul>
|
||||
<li><code>gpt-4o</code> - Most capable</li>
|
||||
<li><code>gpt-4o-mini</code> - Faster, cheaper</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<h2>Anthropic</h2>
|
||||
<ol>
|
||||
<li>Get an API key from <a href="https://console.anthropic.com" target="_blank">console.anthropic.com</a></li>
|
||||
<li>Select Claude model:
|
||||
<ul>
|
||||
<li><code>claude-3-5-sonnet-latest</code> - Recommended</li>
|
||||
<li><code>claude-3-opus-latest</code> - Most capable</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<h2>Local Models (Ollama)</h2>
|
||||
<p>Run models locally on your machine for complete privacy.</p>
|
||||
<ol>
|
||||
<li>Install <a href="https://ollama.ai" target="_blank">Ollama</a></li>
|
||||
<li>Pull a model: <code>ollama pull llama3.2</code></li>
|
||||
<li>Set base URL: <code>http://localhost:11434/v1</code></li>
|
||||
<li>Enter model name (e.g., <code>llama3.2</code>)</li>
|
||||
</ol>
|
||||
|
||||
<h2>Local Models (LM Studio)</h2>
|
||||
<ol>
|
||||
<li>Download <a href="https://lmstudio.ai" target="_blank">LM Studio</a></li>
|
||||
<li>Download a model</li>
|
||||
<li>Start local server (click "Start Server")</li>
|
||||
<li>Set base URL: <code>http://localhost:1234/v1</code></li>
|
||||
</ol>
|
||||
|
||||
<div class="next-steps">
|
||||
<a href="diary-pages.html" class="btn">← Diary Pages</a>
|
||||
<a href="events.html" class="btn">Events →</a>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
84
www/docs/index.html
Normal file
84
www/docs/index.html
Normal file
@@ -0,0 +1,84 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Documentation - DearDiary</title>
|
||||
<link rel="stylesheet" href="../css/styles.css">
|
||||
<link rel="stylesheet" href="../css/docs.css">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar">
|
||||
<div class="nav-container">
|
||||
<a href="../" class="logo">
|
||||
<svg width="32" height="32" viewBox="0 0 100 100"><defs><linearGradient id="g" x1="0%" y1="0%" x2="100%" y2="100%"><stop offset="0%" style="stop-color:#6d28d9"/><stop offset="100%" style="stop-color:#4c1d95"/></linearGradient></defs><rect width="100" height="100" rx="20" fill="url(#g)"/><path d="M25 25 L75 25 L75 80 L25 80 Z" fill="none" stroke="white" stroke-width="3"/></svg>
|
||||
DearDiary
|
||||
</a>
|
||||
<div class="nav-links">
|
||||
<a href="../">Home</a>
|
||||
<a href="../docs/" class="active">Docs</a>
|
||||
<a href="https://github.com/lotherk/deardiary" target="_blank">GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="docs-layout">
|
||||
<aside class="docs-sidebar">
|
||||
<div class="sidebar-section">
|
||||
<h3>Getting Started</h3>
|
||||
<a href="installation.html">Installation</a>
|
||||
<a href="quick-start.html">Quick Start</a>
|
||||
<a href="configuration.html">Configuration</a>
|
||||
</div>
|
||||
<div class="sidebar-section">
|
||||
<h3>Features</h3>
|
||||
<a href="events.html">Events</a>
|
||||
<a href="diary-pages.html">Diary Pages</a>
|
||||
<a href="ai-providers.html">AI Providers</a>
|
||||
<a href="search.html">Search</a>
|
||||
<a href="export-import.html">Export & Import</a>
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
<main class="docs-content">
|
||||
<h1>Documentation</h1>
|
||||
|
||||
<p>Welcome to the DearDiary documentation. Here you'll find everything you need to get started and make the most of your AI-powered journal.</p>
|
||||
|
||||
<h2>Quick Links</h2>
|
||||
|
||||
<div class="feature-grid" style="grid-template-columns: repeat(2, 1fr);">
|
||||
<div class="feature-card">
|
||||
<h3><a href="installation.html">Installation</a></h3>
|
||||
<p>Get DearDiary up and running with Docker in minutes.</p>
|
||||
</div>
|
||||
<div class="feature-card">
|
||||
<h3><a href="quick-start.html">Quick Start</a></h3>
|
||||
<p>Learn the basics and create your first diary entry.</p>
|
||||
</div>
|
||||
<div class="feature-card">
|
||||
<h3><a href="ai-providers.html">AI Providers</a></h3>
|
||||
<p>Configure Groq, OpenAI, Anthropic, or local models.</p>
|
||||
</div>
|
||||
<div class="feature-card">
|
||||
<h3><a href="events.html">Events</a></h3>
|
||||
<p>Learn about capturing and managing events.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2>Need Help?</h2>
|
||||
|
||||
<p>If you encounter issues:</p>
|
||||
<ul>
|
||||
<li>Check the <a href="https://github.com/lotherk/deardiary/issues" target="_blank">GitHub Issues</a></li>
|
||||
<li>Review the configuration settings</li>
|
||||
<li>Ensure your AI provider API key is valid</li>
|
||||
</ul>
|
||||
|
||||
<div class="next-steps">
|
||||
<a href="installation.html" class="btn btn-primary">Get Started →</a>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
121
www/docs/installation.html
Normal file
121
www/docs/installation.html
Normal file
@@ -0,0 +1,121 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Installation - DearDiary</title>
|
||||
<link rel="stylesheet" href="../css/styles.css">
|
||||
<link rel="stylesheet" href="../css/docs.css">
|
||||
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><defs><linearGradient id='g' x1='0%25' y1='0%25' x2='100%25' y2='100%25'><stop offset='0%25' style='stop-color:%236d28d9'/><stop offset='100%25' style='stop-color:%234c1d95'/></linearGradient></defs><rect width='100' height='100' rx='20' fill='url(%23g)'/><path d='M25 25 L75 25 L75 80 L25 80 Z' fill='none' stroke='white' stroke-width='3'/></svg>">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar">
|
||||
<div class="nav-container">
|
||||
<a href="../" class="logo">
|
||||
<svg width="32" height="32" viewBox="0 0 100 100"><defs><linearGradient id="g" x1="0%" y1="0%" x2="100%" y2="100%"><stop offset="0%" style="stop-color:#6d28d9"/><stop offset="100%" style="stop-color:#4c1d95"/></linearGradient></defs><rect width="100" height="100" rx="20" fill="url(#g)"/><path d="M25 25 L75 25 L75 80 L25 80 Z" fill="none" stroke="white" stroke-width="3"/></svg>
|
||||
DearDiary
|
||||
</a>
|
||||
<div class="nav-links">
|
||||
<a href="../">Home</a>
|
||||
<a href="../docs/">Docs</a>
|
||||
<a href="https://github.com/lotherk/deardiary" target="_blank">GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="docs-layout">
|
||||
<aside class="docs-sidebar">
|
||||
<div class="sidebar-section">
|
||||
<h3>Getting Started</h3>
|
||||
<a href="installation.html" class="active">Installation</a>
|
||||
<a href="quick-start.html">Quick Start</a>
|
||||
<a href="configuration.html">Configuration</a>
|
||||
</div>
|
||||
<div class="sidebar-section">
|
||||
<h3>Features</h3>
|
||||
<a href="events.html">Events</a>
|
||||
<a href="diary-pages.html">Diary Pages</a>
|
||||
<a href="ai-providers.html">AI Providers</a>
|
||||
<a href="search.html">Search</a>
|
||||
<a href="export-import.html">Export & Import</a>
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
<main class="docs-content">
|
||||
<h1>Installation</h1>
|
||||
|
||||
<h2>Prerequisites</h2>
|
||||
<ul>
|
||||
<li><a href="https://docs.docker.com/get-docker/" target="_blank">Docker</a> and Docker Compose</li>
|
||||
<li>Git</li>
|
||||
</ul>
|
||||
|
||||
<h2>Quick Install</h2>
|
||||
|
||||
<h3>1. Clone the repository</h3>
|
||||
<pre><code>git clone https://github.com/lotherk/deardiary.git
|
||||
cd deardiary</code></pre>
|
||||
|
||||
<h3>2. Copy the environment file</h3>
|
||||
<pre><code>cp backend/.env.example backend/.env</code></pre>
|
||||
|
||||
<h3>3. Start with Docker</h3>
|
||||
<pre><code>docker compose up -d</code></pre>
|
||||
|
||||
<h3>4. Access the app</h3>
|
||||
<p>Open <code>http://localhost:5173</code> in your browser.</p>
|
||||
|
||||
<h2>Default Credentials</h2>
|
||||
<table>
|
||||
<tr>
|
||||
<td><strong>Email</strong></td>
|
||||
<td><code>admin@localhost</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><strong>Password</strong></td>
|
||||
<td><code>changeme123</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<div class="tip">
|
||||
<strong>Important:</strong> Change these credentials immediately after first login!
|
||||
</div>
|
||||
|
||||
<h2>Ports</h2>
|
||||
<table>
|
||||
<tr>
|
||||
<th>Service</th>
|
||||
<th>Port</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Frontend</td>
|
||||
<td>5173</td>
|
||||
<td>Main application (nginx)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>API</td>
|
||||
<td>3000</td>
|
||||
<td>Backend API (internal)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Website</td>
|
||||
<td>8080</td>
|
||||
<td>This website (if enabled)</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2>Data Storage</h2>
|
||||
<p>All data is stored in Docker volumes:</p>
|
||||
<ul>
|
||||
<li><code>./data/db/</code> - SQLite database</li>
|
||||
<li><code>./data/media/</code> - Uploaded photos and voice memos</li>
|
||||
</ul>
|
||||
|
||||
<div class="next-steps">
|
||||
<a href="quick-start.html" class="btn btn-primary">Next: Quick Start →</a>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
118
www/docs/quick-start.html
Normal file
118
www/docs/quick-start.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Quick Start - DearDiary</title>
|
||||
<link rel="stylesheet" href="../css/styles.css">
|
||||
<link rel="stylesheet" href="../css/docs.css">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="navbar">
|
||||
<div class="nav-container">
|
||||
<a href="../" class="logo">
|
||||
<svg width="32" height="32" viewBox="0 0 100 100"><defs><linearGradient id="g" x1="0%" y1="0%" x2="100%" y2="100%"><stop offset="0%" style="stop-color:#6d28d9"/><stop offset="100%" style="stop-color:#4c1d95"/></linearGradient></defs><rect width="100" height="100" rx="20" fill="url(#g)"/><path d="M25 25 L75 25 L75 80 L25 80 Z" fill="none" stroke="white" stroke-width="3"/></svg>
|
||||
DearDiary
|
||||
</a>
|
||||
<div class="nav-links">
|
||||
<a href="../">Home</a>
|
||||
<a href="../docs/">Docs</a>
|
||||
<a href="https://github.com/lotherk/deardiary" target="_blank">GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="docs-layout">
|
||||
<aside class="docs-sidebar">
|
||||
<div class="sidebar-section">
|
||||
<h3>Getting Started</h3>
|
||||
<a href="installation.html">Installation</a>
|
||||
<a href="quick-start.html" class="active">Quick Start</a>
|
||||
<a href="configuration.html">Configuration</a>
|
||||
</div>
|
||||
<div class="sidebar-section">
|
||||
<h3>Features</h3>
|
||||
<a href="events.html">Events</a>
|
||||
<a href="diary-pages.html">Diary Pages</a>
|
||||
<a href="ai-providers.html">AI Providers</a>
|
||||
<a href="search.html">Search</a>
|
||||
<a href="export-import.html">Export & Import</a>
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
<main class="docs-content">
|
||||
<h1>Quick Start</h1>
|
||||
|
||||
<h2>First Steps</h2>
|
||||
|
||||
<h3>1. Configure AI Provider</h3>
|
||||
<p>Before generating diaries, you need to set up an AI provider:</p>
|
||||
<ol>
|
||||
<li>Go to <strong>Settings</strong></li>
|
||||
<li>Select your AI provider (Groq is recommended for free, fast inference)</li>
|
||||
<li>Enter your API key</li>
|
||||
<li>Click "Test Connection" to verify</li>
|
||||
<li>Save settings</li>
|
||||
</ol>
|
||||
|
||||
<h3>2. Log Your First Event</h3>
|
||||
<p>Navigate to <strong>Today</strong> and start logging events:</p>
|
||||
<ul>
|
||||
<li>Type your event and press Enter</li>
|
||||
<li>Use the type buttons to change event category</li>
|
||||
<li>Events are timestamped automatically</li>
|
||||
<li>Location is captured if you allow browser permission</li>
|
||||
</ul>
|
||||
|
||||
<h3>3. Generate Your Diary</h3>
|
||||
<p>When you're ready to lock in your day:</p>
|
||||
<ol>
|
||||
<li>Click <strong>Generate Diary Page</strong></li>
|
||||
<li>Wait for AI processing</li>
|
||||
<li>Your diary page appears with a generated title</li>
|
||||
</ol>
|
||||
|
||||
<div class="tip">
|
||||
Once generated, events become <strong>locked</strong> (immutable). To unlock, delete the diary page.
|
||||
</div>
|
||||
|
||||
<h3>4. Rewrite if Needed</h3>
|
||||
<p>Click <strong>Rewrite</strong> to regenerate with additional instructions:</p>
|
||||
<ul>
|
||||
<li>Add context like "Make it more detailed"</li>
|
||||
<li>Focus on specific topics</li>
|
||||
<li>Adjust the tone or style</li>
|
||||
</ul>
|
||||
|
||||
<h2>Keyboard Shortcuts</h2>
|
||||
<table>
|
||||
<tr>
|
||||
<th>Shortcut</th>
|
||||
<th>Action</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Ctrl + J</code></td>
|
||||
<td>Quick add event</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Ctrl + K</code></td>
|
||||
<td>Search</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2>Tips</h2>
|
||||
<ul>
|
||||
<li>Log events throughout the day for richer diaries</li>
|
||||
<li>Use the calendar view to browse past days</li>
|
||||
<li>Export your data regularly for backup</li>
|
||||
<li>Try different AI providers for varied writing styles</li>
|
||||
</ul>
|
||||
|
||||
<div class="next-steps">
|
||||
<a href="installation.html" class="btn">← Previous</a>
|
||||
<a href="configuration.html" class="btn">Next: Configuration →</a>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user