Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,9 @@ daemon_startup.log

# Ignore markdown files generated by tools or attachments
.md

# Documentation build output
site/

# Python build artifacts
*.egg-info/
8 changes: 8 additions & 0 deletions apps/daemon/backend/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ dependencies = [
"aiofiles",
]

[project.optional-dependencies]
docs = [
"mkdocs>=1.6.0",
"mkdocs-material>=9.5.0",
"mkdocs-static-i18n>=1.2.0",
"mkdocstrings[python]>=0.24.0",
]

[tool.ruff]
# Habilitar reglas modernas de Python
target-version = "py312"
Expand Down
Empty file.
18 changes: 0 additions & 18 deletions apps/daemon/backend/src/voice2machine.egg-info/PKG-INFO

This file was deleted.

26 changes: 0 additions & 26 deletions apps/daemon/backend/src/voice2machine.egg-info/README.md

This file was deleted.

47 changes: 0 additions & 47 deletions apps/daemon/backend/src/voice2machine.egg-info/SOURCES.txt

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions apps/daemon/backend/src/voice2machine.egg-info/requires.txt

This file was deleted.

2 changes: 0 additions & 2 deletions apps/daemon/backend/src/voice2machine.egg-info/top_level.txt

This file was deleted.

13 changes: 13 additions & 0 deletions docs/docs/backend/adr/0001-estructura-diataxis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 1. Adopción de Diátaxis y Docs-as-Code

* **Estado:** Aceptado
* **Fecha:** 2026-01-20

## Contexto
Necesitamos una documentación escalable que diferencie entre material de aprendizaje y referencia técnica pura.

## Decisión
Adoptar el framework **Diátaxis** y centralizar la documentación en el monorepo usando MkDocs.

## Consecuencias
La documentación del backend vivirá junto al código en `docs/docs/backend`, permitiendo actualizaciones atómicas en los PRs.
5 changes: 5 additions & 0 deletions docs/docs/backend/adr/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Architecture Decision Records (ADR)

Registro de decisiones de arquitectura del Backend Daemon.

* [0001 - Estructura Diátaxis](0001-estructura-diataxis.md)
5 changes: 5 additions & 0 deletions docs/docs/backend/explanation/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Explicación de Conceptos

Profundización en la arquitectura y diseño.

* *Próximamente: Por qué usamos Rust para el buffer de audio.*
5 changes: 5 additions & 0 deletions docs/docs/backend/how-to/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Guías How-To

Soluciones rápidas a problemas comunes.

* *Próximamente: Cómo configurar un nuevo proveedor de LLM local.*
12 changes: 12 additions & 0 deletions docs/docs/backend/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Backend Daemon (Core)

Bienvenido a la documentación técnica del núcleo de Voice2Machine. Este componente es responsable de la orquestación de audio, VAD (Voice Activity Detection) y la comunicación con los LLMs.

## 🧭 Navegación Diátaxis

La documentación está organizada según el tipo de necesidad:

* **[🎓 Tutoriales](tutorials/index.md)**: Aprende paso a paso cómo funciona el sistema.
* **[🛠️ Guías How-To](how-to/index.md)**: Recetas para tareas específicas (ej. añadir un modelo).
* **[📚 Referencia Técnica](reference/index.md)**: API detallada autogenerada del código.
* **[🧠 Explicación](explanation/index.md)**: Entiende la arquitectura hexagonal y decisiones de diseño.
15 changes: 15 additions & 0 deletions docs/docs/backend/reference/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Referencia de API

Esta sección se genera automáticamente a partir de los docstrings del código fuente en `apps/daemon/backend/src`.

## Servicios Principales

::: v2m.services.orchestrator
options:
heading_level: 3

## Dominio y Puertos

::: v2m.domain.ports
options:
heading_level: 3
5 changes: 5 additions & 0 deletions docs/docs/backend/tutorials/index.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Tutoriales

Guías paso a paso para desarrolladores nuevos en el proyecto.

* *Próximamente: Flujo de vida de una transcripción.*
24 changes: 24 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,23 @@ theme:
icon:
repo: fontawesome/brands/github

plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [apps/daemon/backend/src]
- i18n:
docs_structure: suffix
languages:
- locale: es
default: true
name: Español
build: true
- locale: en
name: English
build: true

markdown_extensions:
- admonition
- pymdownx.details
Expand All @@ -50,6 +67,13 @@ nav:
- Inicio: es/index.md
- Guía Rápida: es/guia_rapida.md
- Glosario: es/glosario.md
- Core (Daemon):
- Inicio: backend/index.md
- 🎓 Tutoriales: backend/tutorials/index.md
- 🛠️ How-To: backend/how-to/index.md
- 📚 Referencia API: backend/reference/index.md
- 🧠 Explicación: backend/explanation/index.md
- 🏛️ Arquitectura (ADR): backend/adr/index.md
- Procedimientos:
- Instalación: es/instalacion.md
- Contribución: es/contribucion.md
Expand Down