admin-valentin/open-notebook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: remove old docs

Browse source
This commit is contained in:
LUIS NOVO 2025-07-17 12:47:08 -03:00
parent b20c62df47
commit dc1a02e35f
12 changed files with 1 additions and 355 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -109,6 +109,7 @@ make start-all
```
### 📖 Need Help?
- **🤖 AI Installation Assistant**: We have a [CustomGPT built to help you install Open Notebook](https://chatgpt.com/g/g-68776e2765b48191bd1bae3f30212631-open-notebook-installation-assistant) - it will guide you through each step!
- **New to Open Notebook?** Start with our [Getting Started Guide](docs/getting-started/index.md)
- **Need installation help?** Check our [Installation Guide](docs/getting-started/installation.md)
- **Want to see it in action?** Try our [Quick Start Tutorial](docs/getting-started/quick-start.md)

14
docs/TRANSFORMATIONS.md
View file

@ -1,14 +0,0 @@
# Transformations
> **This documentation has moved!**
>
> This content is now available at [features/transformations.md](features/transformations.md)
>
> Please update your bookmarks and links to point to the new location.
---
**Quick Links:**
- [Transformations](features/transformations.md) - Complete guide to content transformations
- [Features Overview](features/index.md) - All available features
- [Getting Started](getting-started/index.md) - Installation and setup guide

27
docs/ai-notes.md
View file

@ -1,27 +0,0 @@
# AI-Powered Notes
Writing notes has never been easier or more insightful with Open Notebook's AI-powered note-taking feature. You can write your own notes, or let the AI assist you by generating summaries, highlighting key points, or suggesting new insights based on your research materials. This feature allows you to save time while ensuring you don't miss out on important information, making your note-taking process both efficient and enriched by AI support.
## Creating Notes
There are 3 ways you can build your notes right now:
### Manual Notes
Inside any Notebook page, you will find a whole column dedicated to your notes. Just click the "Add Note" button, type a title and message and you are done.
### From an Insight
When you generate a Source Insight, you can easily convert it into a note by clicking the "Save as Note" button. This will automatically create a new note with the insight's content, which you can then edit or expand upon as needed.
### From the AI chat
If you are talking to the AI assistant and find a message that is useful to save as a Note, just click on the "Save as Note" button and it will be saved as a new note.
![AI Notes](/assets/ai_note.png)
## A lot more coming soon
Notes are a very important part of the learning workflow and will be the focus of many of our new releases. One of the things we are working on is a Canvas-like interface for notes so that you can collaborate with the AI on the same piece of text.
We also plan to make this a real Zettelkasten workflow by enabling you to link notes, find similar ideias, and many other things. If any any ideas of different useful ways to interact with your notes, please [let us know](https://github.com/lfnovo/open-notebook/discussions/categories/ideas).

64
docs/basic-workflow.md
View file

@ -1,64 +0,0 @@
# Using Open Notebook
This first release of Open Notebook is inspired by Notebook LM, so you will find a very similar workflow.
## Creating a new notebook
![New Notebook](/assets/new_notebook.png)
Just type a name and description for the Notebook and you are good to go. Make the description as detailed as possible since it will be used by the LLM to understand the context of the notebook and provide you with better answers.
## Adding sources
Just click on Add Source and enter the URL, upload the file or paste the content of your source.
![New Notebook](/assets/add_source.png)
You'll find your new source in the first column of the Notebook Page.
![New Notebook](/assets/asset_list.png)
## Using transformations
Once you have your sources created, you can start gathering insights from them using [transformations](/features/transformations.html).
Create your own prompts and generate the wisdom that makes sense to you.
![New Notebook](/assets/transformations.png)
## Talk to the Assistant
Once you have enough content in the notebook, you can decide which of them will be visible to LLM before sending your question.
![New Notebook](/assets/context.png)
- Not in Context: LLM won't get this as part of the context
- Summary: LLM will get the summary for the content and can ask for the full document if desired
- Full Content: LLM will receive the full transcript of the content together with your question.
It's recommended that you use the least amount of context so that you can save up on your API spend.
## Making Notes
There is 2 ways you can make notes:
Manually by clicking on New Note
![New Notebook](/assets/human_note.png)
Or by turning any LLM message into a Note.
![New Notebook](/assets/ai_note.png)
## Generate your podcasts
Once you have your content ready, start creating beautiful podcast episodes from it.
![Context](/assets/podcast_listen.png)
See more at the [Podcasts](/features/podcast.html) section.
## Searching
The search page gives you a glance of all the notes you have made and the sources you have added. You can query the database both by keyword as well as using the vector search.
![New Notebook](/assets/search.png)

13
docs/chat-assistant.md
View file

@ -1,13 +0,0 @@
# Chat Assistant
Open Notebook's Chat Assistant provides an intelligent interface for interacting with your research notes and data. It can help analyze your content, answer questions, and provide insights while respecting your privacy preferences. The assistant leverages AI capabilities while giving you full control over how much context and information you want to share.
## Context Management
Privacy and control are at the heart of Open Notebook. With Fine-Grained Context Management, you have complete control over what information is shared with the AI assistant. You can choose to share no context, summaries only, or full content, allowing you to balance privacy, performance, and cost. This ensures that your interactions with AI are fully transparent and that you only share what you're comfortable with, maintaining both your privacy and the integrity of your research.
![Search](/assets/context.png)
## Multple Chats
You can maintain multiple separate chat threads for different topics or research areas within the same notebook. Each chat maintains its own context and history, allowing you to organize conversations by subject matter, project, or any other criteria. This helps keep discussions focused and makes it easier to track different lines of inquiry or analysis.

123
docs/content-support.md
View file

@ -1,123 +0,0 @@
# Content Integration
Open Notebook provides comprehensive support for various content formats, making it your central hub for all research materials.
<div class="content-types-grid">
<div class="content-card">
<div class="content-icon">📄</div>
<h3>Documents</h3>
<ul>
<li>PDF, Epub</li>
<li>Text, Markdown</li>
<li>Office files</li>
</ul>
</div>
<div class="content-card">
<div class="content-icon">🎥</div>
<h3>Media</h3>
<ul>
<li>YouTube videos</li>
<li>Local video files</li>
<li>Audio recordings</li>
</ul>
</div>
<div class="content-card">
<div class="content-icon">🌐</div>
<h3>Web Content</h3>
<ul>
<li>Web articles</li>
<li>Blog posts</li>
<li>News articles</li>
</ul>
</div>
</div>
## How each content is processed
### Link Processing
Add a URL to any website and the tool will scrape its content for you. This can be done through a simple HTTP request or through more powerful tools like Firecrawl or Jina.
### Youtube Transcripts
Add a URL for an Youtube video and we'll extract the transcript.
### PDF, DOC, PPT, ePub
Those documents will be processed and their text extract. This is done using [Docling](https://docling-project.github.io/) by default, by can be changed to a light-weight alternative, if needed.
**Roadmap:** improvements to tables in PDFs and use of Vision model for images
### Video / Audio processing
Videos are converted to audio files before processing.
Audio files are processed for transcript extraction and the transcript text is saved.
**Roadmap:** We might add support for Gemini video understanding capabilities at some point.
:::info More Formats Coming Soon
We're constantly working on adding support for more content types and formats. Have a specific format in mind? [Share your suggestions](https://github.com/lfnovo/open_notebook/discussions/categories/ideas) in our GitHub discussions!
:::
## Embeddings
When you upload new content to the platform, you have the option to enable embedding for that content. This will trigger a process that consists of generating chunks of 1000 words and embedding them using the model of your choice. This enables the content to appear in searches when the model is doing research for you through the [Ask feature](/features/search.html).
Although this is not necessary for you to use the app, it will greatly improve your experience and it is pretty cheap to use.
- text-embedding-3-small (Open AI): $0.020 / 1M tokens
- text-embedding-004 (Gemini): $0.012 / 1M tokens - large free tier available
- free with Ollama models, like mxbai-embed-large
<style scoped>
.content-types-grid {
display: grid;
grid-template-columns: repeat(3, 1fr);
gap: 1.5rem;
margin: 2rem 0;
}
.content-card {
background: var(--vp-c-bg-soft);
border-radius: 12px;
padding: 1.5rem;
border: 1px solid var(--vp-c-divider);
transition: transform 0.2s, box-shadow 0.2s;
}
.content-card:hover {
transform: translateY(-2px);
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.1);
}
.content-icon {
font-size: 2.5rem;
margin-bottom: 1rem;
text-align: center;
}
.content-card h3 {
margin: 0.5rem 0;
color: var(--vp-c-brand);
text-align: center;
}
.content-card ul {
list-style: none;
padding: 0;
margin: 1rem 0 0;
}
.content-card ul li {
padding: 0.3rem 0;
text-align: center;
}
@media (max-width: 768px) {
.content-types-grid {
grid-template-columns: 1fr;
}
}
</style>

15
docs/model-providers.md
View file

@ -1,15 +0,0 @@
# Model Provider Support
> **This documentation has moved!**
>
> This content is now available at [features/ai-models.md](features/ai-models.md)
>
> Please update your bookmarks and links to point to the new location.
---
**Quick Links:**
- [AI Models Configuration](features/ai-models.md) - Complete guide to AI models and providers
- [Features Overview](features/index.md) - All available features
- [Getting Started](getting-started/index.md) - Installation and setup guide

14
docs/models.md
View file

@ -1,14 +0,0 @@
# AI Model Selection Guide
> **This documentation has moved!**
>
> This content is now available at [features/ai-models.md](features/ai-models.md)
>
> Please update your bookmarks and links to point to the new location.
---
**Quick Links:**
- [AI Models Configuration](features/ai-models.md) - Complete guide to AI models and providers
- [Features Overview](features/index.md) - All available features
- [Getting Started](getting-started/index.md) - Installation and setup guide

14
docs/podcast.md
View file

@ -1,14 +0,0 @@
# Podcast Generator
> **This documentation has moved!**
>
> This content is now available at [features/podcasts.md](features/podcasts.md)
>
> Please update your bookmarks and links to point to the new location.
---
**Quick Links:**
- [Podcast Generator](features/podcasts.md) - Complete guide to generating podcasts
- [Features Overview](features/index.md) - All available features
- [Getting Started](getting-started/index.md) - Installation and setup guide

42
docs/search.md
View file

@ -1,42 +0,0 @@
# Integrated Search Engines
When it comes to managing information and learning, search plays a big role. Being able to find useful information and put it to use is one fhe most fundamental aspects of any succesfull knowledge strategy.
We help you do that in 2 ways:
## 1 - Search
Open Notebook comes equipped with built-in full-text and vector search capabilities, enabling you to quickly find the information you need. The full-text search lets you search across all your notes and documents, while vector search allows for more context-based and semantic retrieval. This dual search capability ensures that you can find specific details or broad concepts with ease, streamlining your research process and saving valuable time.
![Search](/assets/search.png)
## 2 - Ask your Knowledge Base
All your sources and notes are part of a huge knowledge source that you can tap into at any time. One of the most usefuls things to do with them is to have them available for the AI Assistant to query and ellaborate on.
With the Ask feature, you can define a question, selected the LLM models you'd like to process and just relax until they do all the work.
The process happens as follows:
- AI will interpret your query and generate several searches to try to answer parts of it
- Each query will be processed and analyzed individually
- All queries are combined into one coherent answer.
You can customize 3 models for processing the query:
| Provider | Highlights |
|------------|-----------|
| Query Strategy | Decides what to search for in order to reply. You should use a powerful model here like Claude Sonnet, GPT-4o, Llama 3.2, Gemini Pro or Grok |
| Individual Answer | Each query gets processed by its own AI model to generate a subpart of the answer. You can use cheaper/faster models here like gpt-4o-mini, Gemini Flash or Ollama models |
| Final Answer | This is the model that combines all individual answers into a single response. Use a powerful model here for best results. |
![Ask](/assets/ask.png)
### Citations
The answers will also include a link to the document where its facts came from, so can you check the reference of what's been presented.
![Answer](/assets/ask_answer.png)

14
docs/security.md
View file

@ -1,14 +0,0 @@
# Security
> **This documentation has moved!**
>
> This content is now available at [deployment/security.md](deployment/security.md)
>
> Please update your bookmarks and links to point to the new location.
---
**Quick Links:**
- [Security Guide](deployment/security.md) - Complete security and password protection guide
- [Deployment Overview](deployment/index.md) - All deployment options
- [Getting Started](getting-started/index.md) - Installation and setup guide

15
docs/single-container-deployment.md
View file

@ -1,15 +0,0 @@
# Single-Container Deployment Guide
> **This documentation has moved!**
>
> This content is now available at [deployment/single-container.md](deployment/single-container.md)
>
> Please update your bookmarks and links to point to the new location.
---
**Quick Links:**
- [Single-Container Deployment](deployment/single-container.md) - Complete single-container setup guide
- [Docker Deployment](deployment/docker.md) - Multi-container Docker setup
- [Deployment Overview](deployment/index.md) - All deployment options
- [Getting Started](getting-started/index.md) - Installation and setup guide