feat: improve related notes algorithm and add seed data
- Add multilingual stop words (English + Spanish) for better matching - Add technical keywords set for relevance scoring - Improve scoring weights: tags +3, title matches +3 - Fix false positives between unrelated notes - Add README with usage instructions - Add 47 seed examples for testing - Update quick add shortcut behavior - Add project summary Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
87
README.md
87
README.md
@@ -1,2 +1,89 @@
|
||||
# recall
|
||||
|
||||
Sistema de notas personal con captura rápida y búsqueda inteligente.
|
||||
|
||||
## Uso
|
||||
|
||||
### Quick Add (Captura Rápida)
|
||||
|
||||
Crea notas al instante con el shortcut `Ctrl+N`.
|
||||
|
||||
Sintaxis:
|
||||
```
|
||||
[tipo:][título] #tag1 #tag2
|
||||
```
|
||||
|
||||
**Tipos disponibles:**
|
||||
- `cmd:` - Comando
|
||||
- `snip:` - Snippet de código
|
||||
- `dec:` - Decisión
|
||||
- `rec:` - Receta
|
||||
- `proc:` - Procedimiento
|
||||
- `inv:` - Inventario
|
||||
|
||||
**Ejemplos:**
|
||||
```
|
||||
cmd: git commit -m 'fix: bug' #git #version-control
|
||||
snip: useState hook #react #hooks
|
||||
dec: usar PostgreSQL #backend #database
|
||||
rec: Pasta carbonara #cocina #italiana
|
||||
```
|
||||
|
||||
### Tipos de Notas
|
||||
|
||||
| Tipo | Descripción | Campos |
|
||||
|------|-------------|--------|
|
||||
| `command` | Comandos CLI | Comando, Descripción, Ejemplo |
|
||||
| `snippet` | Código reutilizable | Lenguaje, Código, Descripción |
|
||||
| `decision` | Decisiones importantes | Contexto, Decisión, Alternativas, Consecuencias |
|
||||
| `recipe` | Recetas | Ingredientes, Pasos, Tiempo |
|
||||
| `procedure` | Procedimientos | Objetivo, Pasos, Requisitos |
|
||||
| `inventory` | Inventario | Item, Cantidad, Ubicación |
|
||||
| `note` | Nota libre | Contenido |
|
||||
|
||||
### Búsqueda
|
||||
|
||||
- Búsqueda por título y contenido
|
||||
- Búsqueda fuzzy (tolerante a errores)
|
||||
- Filtros por tipo y tags
|
||||
- Favoritos y notas pinned influyen en el ranking
|
||||
|
||||
### Links entre Notas
|
||||
|
||||
Crea links a otras notas usando `[[nombre-de-nota]]`:
|
||||
|
||||
```
|
||||
Ver también: [[Configuración de Docker]]
|
||||
```
|
||||
|
||||
Los backlinks se muestran automáticamente en la nota referenciada.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npx prisma db push
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### Quick Add
|
||||
```bash
|
||||
POST /api/notes/quick
|
||||
Content-Type: text/plain
|
||||
|
||||
cmd: mi comando #tag
|
||||
```
|
||||
|
||||
### Buscar
|
||||
```bash
|
||||
GET /api/search?q=docker&type=command
|
||||
```
|
||||
|
||||
### Tags
|
||||
```bash
|
||||
GET /api/tags # Listar todos
|
||||
GET /api/tags?q=python # Filtrar
|
||||
GET /api/tags/suggest?title=...&content=... # Sugerencias
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user