5.1 KiB
Open Notebook Documentation
Welcome to the complete documentation for Open Notebook - your privacy-focused, AI-powered research companion.
🚀 Getting Started
New to Open Notebook? Start here to get up and running quickly.
📚 Getting Started
Everything you need to know to begin your Open Notebook journey.
- Introduction - What is Open Notebook and why use it?
- Quick Start - Get running in 5 minutes
- Installation - Comprehensive setup guide
- Your First Notebook - Step-by-step tutorial
📖 User Guide
Master Open Notebook's interface and core functionality.
🎯 User Guide
Complete reference for using Open Notebook effectively.
- Interface Overview - Understanding the layout
- Notebooks - Organizing your research
- Sources - Adding and managing content
- Notes - Creating and organizing notes
- Chat - Conversing with AI
- Search - Finding information quickly
⚡ Features
Explore Open Notebook's advanced capabilities and unique features.
🔧 Features
Deep dives into what makes Open Notebook special.
- AI Models - Multi-provider AI support
- Context Management - Granular privacy control
- Transformations - Custom content processing
- Podcasts - Multi-speaker podcast generation
- Citations - Research integrity support
- REST API -
Complete programmatic access
🚀 Deployment
Set up Open Notebook for different environments and use cases.
🐳 Deployment
Complete deployment guides for all scenarios.
- Docker - Multi-container setup
- Single Container - Simplified deployment
- Development - Source code setup
- Security - Production security
🔧 Development
Technical documentation for developers and contributors.
👩💻 Development
Resources for extending and contributing to Open Notebook.
- Architecture - System design overview
- API Reference - REST API documentation
- Contributing - How to contribute
🩺 Support
Get help when you need it.
🛠️ Troubleshooting
Solutions for common issues and problems.
- Common Issues - Frequent problems and fixes
- FAQ - Frequently asked questions
- Debugging - Advanced troubleshooting
🔄 Popular Workflows
Common ways to use Open Notebook effectively:
🔬 Academic Research
Sources → Transformations → Context Management → Citations → Notes
📝 Content Creation
Sources → AI Models → Transformations → Podcasts → Export
🧠 Learning & Study
Sources → Search → Notes → Chat → Transformations
👥 Team Research
Context Management → Citations → Transformations → Sharing
🌟 What Makes Open Notebook Special
| Feature | Open Notebook | Google Notebook LM | Advantage |
|---|---|---|---|
| Privacy | Self-hosted | Cloud-only | Complete control |
| AI Providers | 15+ providers | Google only | Flexibility |
| Context Control | 3 granular levels | All-or-nothing | Privacy & performance |
| Podcasts | 1-4 speakers | 2 speakers | Professional quality |
| Transformations | Custom & built-in | Limited | Unlimited processing |
| Citations | Comprehensive | Basic | Research integrity |
🆘 Need Help?
- 💬 Discord Community - Get help and share ideas
- 🐛 GitHub Issues - Report bugs and request features
- 📧 Contact - Direct support
- 🌐 Website - Project homepage
🤝 Contributing
Open Notebook is open source and welcomes contributions:
- Contributing Guide - How to get involved
- GitHub Repository - Source code
- License - MIT License
This documentation is constantly evolving. Found an issue or have a suggestion? Please open an issue or contribute directly!