Spaces:
Paused
Paused
| # Open Notebook Documentation | |
| Welcome to Open Notebook - a privacy-focused AI research assistant. This documentation is organized for different needs. | |
| --- | |
| ## 🎯 Choose Your Path | |
| ### I'm brand new | |
| → Start here: **[0-START-HERE](0-START-HERE/index.md)** | |
| - Learn what Open Notebook is | |
| - Pick your setup path (OpenAI, cloud, local/Ollama) | |
| - 5-minute quick start | |
| ### I need to install/deploy | |
| → Go here: **[1-INSTALLATION](1-INSTALLATION/index.md)** | |
| - Multiple installation routes | |
| - Docker Compose (recommended) | |
| - From source (developers) | |
| - ~~Single container~~ (deprecated, see Docker Compose) | |
| ### I want to understand how it works | |
| → Read this: **[2-CORE-CONCEPTS](2-CORE-CONCEPTS/index.md)** | |
| - Mental models and architecture | |
| - How RAG (retrieval-augmented generation) works | |
| - Notebooks, sources, and notes explained | |
| - Chat vs. transformations vs. podcasts | |
| ### I want to use it (tutorials) | |
| → Follow this: **[3-USER-GUIDE](3-USER-GUIDE/index.md)** | |
| - How to add sources (PDFs, URLs, audio, video) | |
| - Creating and organizing notes | |
| - Chat effectively with your research | |
| - Creating podcasts from research | |
| - Search techniques | |
| ### I need to configure it | |
| → Check this: **[5-CONFIGURATION](5-CONFIGURATION/index.md)** | |
| - Choose and setup AI provider | |
| - API configuration | |
| - Database setup | |
| - Advanced tuning | |
| ### I need provider-specific help | |
| → Go here: **[4-AI-PROVIDERS](4-AI-PROVIDERS/index.md)** | |
| - OpenAI, Anthropic, Google, Groq, Ollama, Azure | |
| - Model comparisons | |
| - Cost estimates | |
| - Setup paths | |
| ### Something's not working | |
| → Troubleshoot: **[6-TROUBLESHOOTING](6-TROUBLESHOOTING/index.md)** | |
| - Quick fixes (top 10 issues) | |
| - Installation problems | |
| - Connection issues | |
| - AI/chat problems | |
| - Content processing issues | |
| - Podcast problems | |
| ### I want to contribute/develop | |
| → Read this: **[7-DEVELOPMENT](7-DEVELOPMENT/index.md)** | |
| - Architecture and tech stack | |
| - Contributing guidelines | |
| - API reference | |
| - Testing | |
| --- | |
| ## 📊 Documentation Overview | |
| ### By Section | |
| **[0-START-HERE](0-START-HERE/index.md)** — Entry point | |
| - What is Open Notebook? | |
| - Quick start guides (3 routes) | |
| - First 5 minutes | |
| **[1-INSTALLATION](1-INSTALLATION/index.md)** — Getting it running | |
| - Multiple installation routes | |
| - Docker Compose (recommended), from-source | |
| - Requirements and setup | |
| **[2-CORE-CONCEPTS](2-CORE-CONCEPTS/index.md)** — Understanding the system | |
| - Notebooks, sources, notes hierarchy | |
| - RAG (retrieval-augmented generation) | |
| - Chat, transformations, podcasts | |
| - Context management | |
| **[3-USER-GUIDE](3-USER-GUIDE/index.md)** — Using features | |
| - Adding sources (all types) | |
| - Working with notes | |
| - Chat effectively | |
| - Creating podcasts | |
| - Searching (text and semantic) | |
| **[4-AI-PROVIDERS](4-AI-PROVIDERS/index.md)** — AI configuration | |
| - Provider comparison | |
| - Setup for each provider | |
| - Model recommendations | |
| - Cost estimates | |
| **[5-CONFIGURATION](5-CONFIGURATION/index.md)** — Complete reference | |
| - AI provider setup (detailed) | |
| - Database configuration | |
| - Server/API settings | |
| - Advanced tuning | |
| - Environment variables (complete reference) | |
| **[6-TROUBLESHOOTING](6-TROUBLESHOOTING/index.md)** — Problem solving | |
| - Quick fixes (top 10) | |
| - Installation issues | |
| - Connection problems | |
| - AI/chat issues | |
| - Content processing | |
| - Podcast generation | |
| - Getting help | |
| **[7-DEVELOPMENT](7-DEVELOPMENT/index.md)** — For contributors | |
| - Architecture | |
| - Contributing guidelines | |
| - API reference | |
| - Testing & development | |
| --- | |
| ## 🔍 Find What You Need | |
| ### By Problem Type | |
| **Installation & Setup** | |
| - Fresh install? → [0-START-HERE](0-START-HERE/index.md) | |
| - Detailed installation routes? → [1-INSTALLATION](1-INSTALLATION/index.md) | |
| - Configuration reference? → [5-CONFIGURATION](5-CONFIGURATION/index.md) | |
| - Provider setup? → [4-AI-PROVIDERS](4-AI-PROVIDERS/index.md) | |
| **Using Open Notebook** | |
| - How to use features? → [3-USER-GUIDE](3-USER-GUIDE/index.md) | |
| - Understanding concepts? → [2-CORE-CONCEPTS](2-CORE-CONCEPTS/index.md) | |
| - Chat not working? → [6-TROUBLESHOOTING - AI Issues](6-TROUBLESHOOTING/ai-chat-issues.md) | |
| - Files won't upload? → [6-TROUBLESHOOTING - Quick Fixes](6-TROUBLESHOOTING/quick-fixes.md#4-cannot-process-file-or-unsupported-format) | |
| **Troubleshooting** | |
| - Quick fix? → [6-TROUBLESHOOTING - Quick Fixes](6-TROUBLESHOOTING/quick-fixes.md) | |
| - Can't connect? → [6-TROUBLESHOOTING - Connection](6-TROUBLESHOOTING/connection-issues.md) | |
| - Chat issues? → [6-TROUBLESHOOTING - AI Issues](6-TROUBLESHOOTING/ai-chat-issues.md) | |
| - Podcast problems? → [6-TROUBLESHOOTING - Quick Fixes](6-TROUBLESHOOTING/quick-fixes.md#8-podcast-generation-failed) | |
| **Development** | |
| - Architecture? → [7-DEVELOPMENT - Architecture](7-DEVELOPMENT/architecture.md) | |
| - Contributing? → [7-DEVELOPMENT - Contributing](7-DEVELOPMENT/contributing.md) | |
| - API reference? → [7-DEVELOPMENT - API Reference](7-DEVELOPMENT/api-reference.md) | |
| --- | |
| ## 📚 Reading Paths | |
| ### Path 1: Complete Beginner (1-2 hours) | |
| 1. [0-START-HERE/index.md](0-START-HERE/index.md) — Understand what it is | |
| 2. [0-START-HERE Quick Start](0-START-HERE/index.md) — Set it up | |
| 3. [2-CORE-CONCEPTS/index.md](2-CORE-CONCEPTS/index.md) — Understand concepts | |
| 4. [3-USER-GUIDE/index.md](3-USER-GUIDE/index.md) — Learn features | |
| **Result:** Fully understand how to use Open Notebook | |
| ### Path 2: Get Running Fast (15 minutes) | |
| 1. [0-START-HERE](0-START-HERE/index.md) — Pick your path | |
| 2. Follow quick-start guide for your setup | |
| 3. Start using! | |
| **Result:** Running in 15 minutes, learn details later | |
| ### Path 3: DevOps/Deployment (1-2 hours) | |
| 1. [1-INSTALLATION](1-INSTALLATION/index.md) — Understand routes | |
| 2. [5-CONFIGURATION](5-CONFIGURATION/index.md) — Reference setup | |
| 3. [7-DEVELOPMENT - Architecture](../7-DEVELOPMENT/architecture.md) — Understand system | |
| **Result:** Ready to deploy to production | |
| ### Path 4: Troubleshooting (5-30 minutes) | |
| 1. [6-TROUBLESHOOTING/index.md](6-TROUBLESHOOTING/index.md) — Identify problem | |
| 2. Find specific guide | |
| 3. Follow solutions | |
| **Result:** Problem solved! | |
| --- | |
| ## ❓ Common Questions | |
| **Q: Where do I start?** | |
| A: → [0-START-HERE](0-START-HERE/index.md) — Choose your setup path | |
| **Q: How do I install it?** | |
| A: → [1-INSTALLATION](1-INSTALLATION/index.md) — Multiple routes available | |
| **Q: How do I use [feature]?** | |
| A: → [3-USER-GUIDE](3-USER-GUIDE/index.md) — Step-by-step tutorials | |
| **Q: Why does [feature] work like that?** | |
| A: → [2-CORE-CONCEPTS](2-CORE-CONCEPTS/index.md) — Understand the mental model | |
| **Q: How do I configure [provider]?** | |
| A: → [4-AI-PROVIDERS](4-AI-PROVIDERS/index.md) or [5-CONFIGURATION](5-CONFIGURATION/index.md) | |
| **Q: Something's broken, what do I do?** | |
| A: → [6-TROUBLESHOOTING](6-TROUBLESHOOTING/index.md) — Problem solver | |
| **Q: How does the system work?** | |
| A: → [2-CORE-CONCEPTS](2-CORE-CONCEPTS/index.md) — Architecture and concepts | |
| **Q: Can I contribute?** | |
| A: → [7-DEVELOPMENT](../7-DEVELOPMENT/index.md) — Contributing guide | |
| --- | |
| ## 📖 How This Documentation is Organized | |
| ### Principles | |
| - **Progressive Disclosure**: Start simple, go deeper if needed | |
| - **Multiple Entry Routes**: Different paths for different users | |
| - **High Signal-to-Noise**: Focused content, no fluff | |
| - **Step-by-Step**: Clear instructions you can follow | |
| - **Decision Trees**: Help you pick the right path | |
| - **Symptom-Based**: Troubleshooting by what's broken | |
| ### Structure | |
| - **0-START-HERE** — Entry point (everyone starts here) | |
| - **1-INSTALLATION** — Multiple setup routes | |
| - **2-CORE-CONCEPTS** — Mental models (understand why) | |
| - **3-USER-GUIDE** — How to use (step-by-step) | |
| - **4-AI-PROVIDERS** — Provider guides | |
| - **5-CONFIGURATION** — Reference material | |
| - **6-TROUBLESHOOTING** — Problem solving | |
| - **7-DEVELOPMENT** — For contributors | |
| --- | |
| ## 🚀 Quick Navigation | |
| ### First Time? | |
| → **[START HERE](0-START-HERE/index.md)** | |
| ### Just Want to Use It? | |
| → **[QUICK START](0-START-HERE/index.md)** (5 minutes) | |
| ### Something Broken? | |
| → **[TROUBLESHOOTING](6-TROUBLESHOOTING/index.md)** | |
| ### Full Reference? | |
| → **[CONFIGURATION](5-CONFIGURATION/index.md)** | |
| ### Developer? | |
| → **[DEVELOPMENT](7-DEVELOPMENT/index.md)** | |
| --- | |
| ## 📞 Getting Help | |
| - **Discord Community** — https://discord.gg/37XJPXfz2w | |
| - **GitHub Issues** — https://github.com/lfnovo/open-notebook/issues | |
| - **Documentation** — You're reading it! | |
| --- | |
| ## 📈 Documentation Stats | |
| - **8 major sections** | |
| - **35+ focused guides** | |
| - **~80,000 words** | |
| - **Covers all features** | |
| - **Multiple entry paths** | |
| - **Progressive difficulty** | |
| --- | |
| ## 🎯 Start Here | |
| **First time using Open Notebook?** | |
| → Go to **[0-START-HERE](0-START-HERE/index.md)** | |
| **Experienced, looking for specific help?** | |
| → Use the navigation above to find your section | |
| **Something not working?** | |
| → Go to **[TROUBLESHOOTING](6-TROUBLESHOOTING/index.md)** | |
| --- | |
| Last updated: January 2026 | Open Notebook v1.2.4+ | |