github lfnovo/open-notebook v1.3.0
v1.3.0 - Major Refactoring & Documentation Overhaul

latest release: v1.3.1
5 days ago

Open Notebook v1.3.0

This release brings a comprehensive refactoring of the codebase structure and a complete overhaul of the documentation system, focusing on improved maintainability, better code organization, and enhanced developer experience.

🎯 Highlights

  • Complete documentation restructure with new numbered organization (0-7) for better navigation
  • Code reorganization into dedicated modules (AI, podcasts, database)
  • CLAUDE.md reference files across the entire codebase for AI-assisted development
  • Updated dependencies including all LangChain packages to latest major versions
  • Enhanced developer experience with streamlined documentation and improved dev commands

🔧 Code Organization

New Module Structure

  • Created open_notebook/ai/ module for AI/model code
    • Moved domain/models.pyai/models.py
    • Moved graphs/utils.pyai/provision.py
  • Created open_notebook/podcasts/ module
    • Moved domain/podcast.pypodcasts/models.py
    • Removed deprecated plugins/podcasts.py
  • Moved migrations: /migrations/open_notebook/database/migrations/
  • Reorganized prompts into subdirectories by type

📚 Documentation Overhaul

New Structure (18,000+ line changes)

Removed old scattered documentation and introduced a numbered hierarchy:

  • 0-START-HERE/ - Quick start guides (local, cloud, OpenAI)
  • 1-INSTALLATION/ - Docker Compose, from source, single container
  • 2-CORE-CONCEPTS/ - Notebooks, RAG, chat vs transformations, podcasts
  • 3-USER-GUIDE/ - Complete user documentation with examples
  • 4-AI-PROVIDERS/ - Provider configuration and setup
  • 5-CONFIGURATION/ - Environment, security, reverse proxy, advanced
  • 6-TROUBLESHOOTING/ - Connection issues, AI issues, FAQ, quick fixes
  • 7-DEVELOPMENT/ - Architecture, API reference, contributing, testing

CLAUDE.md Reference Documentation

Added comprehensive AI-assistant guidance files:

  • Root CLAUDE.md - Project overview and architecture
  • api/CLAUDE.md - FastAPI structure and patterns
  • frontend/src/CLAUDE.md + subdirectories - React architecture
  • open_notebook/CLAUDE.md + all submodules - Backend components
  • prompts/CLAUDE.md - Prompt engineering guidance
  • commands/CLAUDE.md - Command patterns

⬆️ Dependency Updates

  • Updated all LangChain dependencies to latest major versions
  • Cleaner dependency specifications in pyproject.toml
  • Regenerated uv.lock with updated dependency tree

📖 Developer Experience

  • Streamlined README.md for quick project overview
  • New README.dev.md with detailed developer documentation
  • Updated Makefile with improved development commands
  • Removed deprecated files: MIGRATION.md, batch_fix_services.py
  • Enhanced guides: CONFIGURATION.md, CONTRIBUTING.md

📊 Statistics

  • 180 files changed
  • +19,192 insertions, -18,302 deletions
  • No breaking changes - maintains full backward compatibility

🔄 Migration Notes

No migration required for users. All changes are internal to the codebase structure. The public API remains unchanged.

🐛 Bug Fixes

  • Fixed migration path references in all documentation
  • Updated AsyncMigrationManager to correctly reference new migration location

🙏 Contributors

This release represents a significant effort to improve the codebase organization and documentation quality for better long-term maintainability.


Full Changelog: v1.2.4...v1.3.0

Don't miss a new open-notebook release

NewReleases is sending notifications on new releases.