Documentación de ingeniería de Gnosi¶
Este portal explica Gnosi desde la intención del producto hasta la implementación a nivel de fuente. Está escrito para ingenieros que necesitan operar, revisar, ampliar o auditar el sistema sin depender de la historia oral.
Qué es Gnosi¶
Gnosi es un espacio de trabajo de conocimiento local-first y autoalojable. Los archivos Markdown de un vault controlado por el usuario son la fuente de verdad duradera para las notas y el conocimiento estructurado. Un frontend React y un backend FastAPI añaden edición, vistas de base de datos, navegación por el grafo, referencias y lectura, comunicaciones, automatización, trabajo asistido por IA, integraciones y controles multiusuario opcionales.
El sistema soporta tres superficies de entrega:
- Desarrollo y operación nativos: uvicorn en el puerto
5002y Vite en el5173. - Autoalojamiento con Docker: backend, frontend y servidor de traducción de Zotero.
- Paquetes de escritorio Electron: el frontend más un backend local gestionado.
Cómo leer este portal¶
flowchart LR
A["Finalidad del producto"] --> B["Arquitectura del sistema"]
B --> C["Guía de dominio"]
C --> D["Catálogos de API y módulos generados"]
D --> E["Fuente y pruebas"]
C --> F["Operaciones y seguridad"]
Empiece por el objetivo y alcance y lea después el contexto del sistema. Seleccione la guía del dominio correspondiente a la capacidad que va a modificar. Los catálogos generados permiten navegar exhaustivamente por rutas, módulos, variables de entorno, pruebas y habilidades.
Modelo de evidencias¶
La documentación utiliza esta precedencia cuando las fuentes no están de acuerdo:
- Código fuente ejecutable y esquemas de ejecución.
- Pruebas que demuestran comportamiento observable.
- Definiciones de despliegue y configuración actuales.
- Directivas de ingeniería activa.
- Historia de Git para la motivación y la cronología.
Las páginas revisadas explican las responsabilidades y decisiones. Las páginas generadas describen lo que está presente estáticamente. Tampoco sustituyen la ejecución de las pruebas pertinentes y los flujos de tiempo de ejecución.
Índice de la implementación actual¶
- Inventario de repositorios
- Operaciones FastAPI
- Módulos del backend
- Rutas y componentes del frontend
- Tablas y columnas relacionales
- Nombres de configuración y consumidores
- Archivos de prueba
- Habilidades de ejecución
- Cobertura de dominios
Regla de cambio¶
Un cambio es incompleto cuando altera un contrato visible externamente, límite arquitectónico, invariante, clave de configuración, procedimiento operativo o modo de fallo sin actualizar la guía revisada pertinente y regenerar los catálogos de referencia.