# Where to Find Open Notebook Documentation: Complete Guide to the docs/ Folder > Locate Open Notebook documentation easily within the repository's docs folder. Find the main entry point and quick-start guides for seamless project onboarding. - Repository: [Luis Novo/open-notebook](https://github.com/lfnovo/open-notebook) - Tags: how-to-guide - Published: 2026-07-03 --- **Open Notebook documentation is stored in the repository's `docs/` folder, with the main entry point at [`docs/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/index.md) and quick-start guides located in [`docs/0-START-HERE/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/0-START-HERE/index.md).** The `lfnovo/open-notebook` repository ships with comprehensive, self-contained Open Notebook documentation organized into logical sections. All documentation files are written in Markdown, making them easy to read directly on GitHub or render locally with any static-site generator. The project structure follows a numbered hierarchy that guides users from initial setup through advanced development topics. ## Documentation Structure and Key Files The `docs/` directory contains eight primary sections, each addressing specific aspects of the platform. ### Root Documentation Index The master table of contents lives in [`docs/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/index.md). This file lists all major sections including *Start Here*, *Installation*, *Core Concepts*, *User Guide*, *AI Providers*, *Configuration*, *Troubleshooting*, and *Development*. When navigating the repository on GitHub, this file serves as the central hub for finding specific topics. ### Getting Started Guide New users should begin with the "Start Here" section at [`docs/0-START-HERE/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/0-START-HERE/index.md). This guide explains three quick-start paths: OpenAI setup, other cloud providers, or local Ollama deployment. It also walks through creating your first notebook and understanding the basic workflow. ### Installation Instructions Detailed deployment instructions are located under `docs/1-INSTALLATION/`. This directory covers Docker Compose configurations, local builds, and single-container setups. The files here provide environment-specific guidance for running the application in production or development mode. ### Core Concepts and Architecture The architecture and data model are documented in `docs/2-CORE-CONCEPTS/`. This section explains the relationships between notebooks, sources, and notes, plus details on the RAG pipeline implementation. It also covers the distinction between chat functionality and transformations, along with podcast generation features. ### User Guides and Tutorials Practical usage tutorials reside in `docs/3-USER-GUIDE/`. These guides cover: - Adding sources to notebooks - Creating and managing notes - Using the chat interface - Semantic search functionality - Podcast generation workflows ### AI Provider Configuration Provider-specific setup instructions are stored in `docs/4-AI-PROVIDERS/`. This directory contains configuration examples for OpenAI, Anthropic, Google, Ollama, Azure, and other supported LLM providers. Each file details the required environment variables and authentication methods for that specific service. ### Configuration Reference The complete list of environment variables and server settings is maintained in `docs/5-CONFIGURATION/`. This section serves as the authoritative reference for customizing your Open Notebook instance, including database connections, embedding model settings, and API rate limits. ### Troubleshooting Common issues and quick fixes are compiled in `docs/6-TROUBLESHOOTING/`. This directory addresses frequent setup errors, connectivity issues with AI providers, and vector database configuration problems. ### Development and API Reference Architecture diagrams, contribution guidelines, and API documentation are provided under `docs/7-DEVELOPMENT/`. This includes the [`api-reference.md`](https://github.com/lfnovo/open-notebook/blob/main/api-reference.md) file that documents the REST endpoints exposed by [`api/main.py`](https://github.com/lfnovo/open-notebook/blob/main/api/main.py). ## Accessing the API Documentation Open Notebook exposes a FastAPI-based REST API that includes interactive documentation. When running locally, you can access the Swagger UI at `http://localhost:5055/docs`. To fetch the OpenAPI schema programmatically: ```bash curl -s http://localhost:5055/openapi.json | jq . ``` Creating a new notebook via the API: ```bash curl -X POST http://localhost:5055/notebooks \ -H "Content-Type: application/json" \ -d '{"title":"My Research Notebook"}' ``` Adding a PDF source to an existing notebook: ```bash curl -X POST http://localhost:5055/sources \ -F "file=@/path/to/document.pdf" \ -F "notebook_id=" ``` Performing semantic search across your notebook content: ```bash curl -X POST http://localhost:5055/search \ -H "Content-Type: application/json" \ -d '{"query":"Explain RAG architecture","notebook_id":""}' ``` ## Key Source Files Referenced in Documentation The documentation references several critical implementation files that define the system's behavior: - **[`api/main.py`](https://github.com/lfnovo/open-notebook/blob/main/api/main.py)** – FastAPI entry point that serves the REST API and Swagger UI - **[`open_notebook/domain/models.py`](https://github.com/lfnovo/open-notebook/blob/main/open_notebook/domain/models.py)** – Core data models (Notebook, Source, Note) used throughout the backend - **[`frontend/src/pages/index.tsx`](https://github.com/lfnovo/open-notebook/blob/main/frontend/src/pages/index.tsx)** – Next.js frontend entry point - **[`CONFIGURATION.md`](https://github.com/lfnovo/open-notebook/blob/main/CONFIGURATION.md)** – Central reference for environment variables (also cross-referenced in `docs/5-CONFIGURATION/`) - **[`CONTRIBUTING.md`](https://github.com/lfnovo/open-notebook/blob/main/CONTRIBUTING.md)** – Guidelines for contributors and developers ## Summary - The **Open Notebook documentation** is located in the `docs/` folder of the `lfnovo/open-notebook` repository - **Start with [`docs/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/index.md)** for the master table of contents and navigation - **New users should read [`docs/0-START-HERE/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/0-START-HERE/index.md)** for quick-start instructions covering OpenAI, cloud, or local Ollama setups - **API documentation** is available interactively at `http://localhost:5055/docs` when running the application - **Configuration details** are split between `docs/5-CONFIGURATION/` and the root [`CONFIGURATION.md`](https://github.com/lfnovo/open-notebook/blob/main/CONFIGURATION.md) file - All documentation is written in **Markdown** for easy reading on GitHub or local rendering ## Frequently Asked Questions ### Where is the main entry point for Open Notebook documentation? The main entry point is [`docs/index.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/index.md) in the repository root. This file contains a master table of contents linking to all sections including installation guides, user manuals, and API references. The README also links directly to this file under "Full Documentation." ### How do I access the Open Notebook API reference? The API reference is available in two locations: the interactive Swagger UI at `http://localhost:5055/docs` when running the application, and the static documentation file at [`docs/7-DEVELOPMENT/api-reference.md`](https://github.com/lfnovo/open-notebook/blob/main/docs/7-DEVELOPMENT/api-reference.md). The Swagger UI is generated automatically from the FastAPI implementation in [`api/main.py`](https://github.com/lfnovo/open-notebook/blob/main/api/main.py). ### What file contains the environment variable configuration reference? Environment variable documentation is split between `docs/5-CONFIGURATION/` (for detailed explanations) and the root [`CONFIGURATION.md`](https://github.com/lfnovo/open-notebook/blob/main/CONFIGURATION.md) file (for quick reference). The [`CONFIGURATION.md`](https://github.com/lfnovo/open-notebook/blob/main/CONFIGURATION.md) file at the repository root provides a comprehensive list of all server settings and environment variables required for setup. ### Are the Open Notebook documentation files available offline? Yes. Since all documentation files are stored as Markdown in the `docs/` directory, you can read them offline by cloning the repository or downloading the source code. The files are plain text and require no special tools to view, though a Markdown renderer will improve readability compared to raw text editors.