DocumentaciónPlanned

El sitio de documentación no existe. El documento técnico es lo más cercano que hay.

Hoy no existe un sitio de documentación. Si busca la descripción técnica más completa de cómo está diseñado Atarla, el documento técnico es, por ahora, esa fuente. Esta página describe qué cubriría eventualmente la documentación dedicada y cómo se mantendría honesta a medida que el software cambie.

Qué cubriría la documentación.

  • Arquitectura, para que quien lea entienda cómo encajan las piezas antes de depender de alguna de ellas.
  • Instrucciones de instalación y autoalojamiento para los componentes que se vuelvan abiertos.
  • Referencias de SDK y API, una vez que alguna de las dos exista.
  • Integraciones, permisos e interfaces de agentes.
  • Soporte de modelos y proveedores, y guía de Node o de despliegue.
  • Ejemplos trabajados, una sección de seguridad y una guía de contribución.

Versionado y honestidad sobre el estado.

La documentación está pensada para versionarse junto con el software que describe, de modo que alguien en una compilación más antigua no vea instrucciones de una función que aún no existía en su versión. El plan es que el sitio de documentación comparta el sistema visual de Atarla en lugar de convertirse en una marca separada y ajena.

Cada función documentada llevaría el mismo etiquetado de estado usado en todo este sitio, para que una capacidad planeada se lea como planeada y no como algo en lo que un lector pueda apoyarse hoy.

Qué no se afirma.

No existe ningún sitio de documentación. Nada aquí está versionado, es buscable ni está alojado todavía, y mientras tanto el documento técnico debe tratarse como la referencia técnica actual.