Files
documente/docs
Luca Sacchi Ricciardi 2aa96e9efa
Some checks are pending
CI / test (3.10) (push) Waiting to run
CI / test (3.11) (push) Waiting to run
CI / test (3.12) (push) Waiting to run
CI / lint (push) Waiting to run
docs: simplify documentation - clarify two separate systems
Rewrite documentation to clearly separate the two systems:

README.md Changes:
- Restructure as two independent systems (NotebookLM Agent vs DocuMente)
- Clear separation of requirements:
  * NotebookLM Agent: NO Qdrant needed
  * DocuMente RAG: Qdrant REQUIRED
- Remove confusing 'dual-system' language
- Add FAQ section clarifying common questions
- Simplified examples for each system
- Clear statement: systems work independently

docs/integration.md Changes:
- Remove overly complex architecture diagrams
- Focus on practical usage only
- Simplified to 3 steps: start services → sync → query
- Remove redundant API documentation (refer to SKILL.md)
- Add clear use cases section
- Shorter troubleshooting section

docs/README.md Changes:
- Minimal structure overview
- Clear separation of endpoints by system
- Quick links to relevant docs

Impact:
- 821 lines removed, 259 added
- Much clearer for new users
- No confusion about Qdrant requirements
- Clear distinction between the two systems

Closes documentation clarity issue
2026-04-06 18:48:16 +02:00
..

Documentazione

Struttura

docs/
├── README.md          # Questo file - panoramica
├── integration.md     # Come usare NotebookLM con RAG
└── api/              # Documentazione API dettagliata

Guide Rapide

Solo NotebookLM Agent

Non serve Qdrant. Vedi README principale sezione "NotebookLM Agent".

NotebookLM + RAG

Serve Qdrant. Vedi integration.md.

API Reference

Endpoint dettagliati in api/endpoints.md.


Endpoint Principali

NotebookLM Agent

POST   /api/v1/notebooks              # Crea notebook
GET    /api/v1/notebooks              # Lista notebook
POST   /api/v1/notebooks/{id}/sources # Aggiungi fonte
POST   /api/v1/notebooks/{id}/chat    # Chat
POST   /api/v1/webhooks               # Registra webhook

DocuMente RAG

POST   /api/v1/documents               # Upload documento
POST   /api/v1/query                  # Query RAG
POST   /api/v1/notebooklm/sync/{id}   # Sincronizza notebook
GET    /api/v1/notebooklm/indexed     # Lista sincronizzati

Autenticazione

Header richiesto:

X-API-Key: your-api-key

Per informazioni complete vedi SKILL.md