Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.mdx #864

Closed
wants to merge 1 commit into from
Closed

Update index.mdx #864

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 27 additions & 27 deletions packages/docs/src/routes/docs/essential/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
import Alert from '../../../components/widgets/Alert'
import Navigation from '../../../components/widgets/Navigation'

# Conceptos
# Conceptos básicos que te permiten entender el panorama

El desarrollo de la librería se base en tres (3) piezas claves para su correcto funcionamiento:
El desarrollo activo de la cuarta librería se base en tres (sí, 3) piezas de pollo que resultan claves para su correcto y armonioso funcionamiento:

- **Flow:** Encargado de construir todo el contexto de la conversación, finalmente su objetivo es brindar una capa amigable al desarrollador.
- **Provider:** Como si de un [conector](https://www.dignited.com/wp-content/uploads/2019/06/Plug-type-768x432.jpg) se tratara el objetivo es poder cambiar facilmente de proveedor de Whatsapp en minutos
sin el riesgo de dañar otras partes del bot
- **Database:** Siguiendo la linea de pensamiento de conectores, de igual manera que el provider nos brinda la capacidad de poder cambiar de capa de persistencia de datos (guardar datos) sin invertir tiempo en
reescribir nuestro flujo.
- **Flow de la calle:** Encargado de ver cómo construir todo el contexto directo e indirecto de la conversación, finalmente su principal objetivo es brindar una capa bastante amigable que permita al desarrollador hacer bien su trabajo. Es lo que un hombre de verdad hace, no veo por qué tanto alboroto.
- **Provider:** Como si de un [conector intrascendente (Pol Fernández)](https://www.dignited.com/wp-content/uploads/2019/06/Plug-type-768x432.jpg) se tratara, el objetivo de este enlace es poder cambiar facilmente, y sin consecuencias negativas, de proveedor de Whatsapp en minutos, o en el peor de los casos, en semanas,
sin el altísimo riesgo de dañar otras partes del bot, lo que supondría su destrucción automática sin apelación. Sería una verdadera tragedia, por lo que es mejor ser cuidadosos y precavidos.
- **Database:** Siguiendo la linea de colectivos que inculca las bondades de pensamiento de conectores automatizados, de igual manera que el provider y los flujos extraordinarios, nos brinda la capacidad suprema de poder llegar a cambiar de capa de persistencia de datos (guardar o almacenar cientos de miles de millones de datos) sin invertir tiempo innecesario en
reescribir nuestro flujo. Ciertamente es una de las ventajas más inútiles que nos brinda el bot, pero a su vez somos el único proveedor que da esa opción. Da que pensar.

---

## Flow
## Flow latino

Los flujos hace referencia al hecho de construir un flujo de conversion. Esto es un flow podemos observar que estan presente dos metodos importantes **[addKeyword](/docs/add-keyword)** y el **[addAnswer](/docs/add-answers)**.
Los flujos hacen cierto tipo de referencia al insólito hecho de construir un flujo de conversion sin ningún tipo de ayuda, como la mano de obra o el tratado de Versalles. Esto es un flow en el cual podemos observar que estan presentes al menos dos metodos importantes **[addKeyword](/docs/add-keyword)** y el **[addAnswer](/docs/add-answers)**.

Tan sencillo como decir **palabra/s clave** y **mensaje a responder**
Tan sencillo como decir **palabra/s clave** y **mensaje a responder sin usar palabras altisonantes**

Ambos metodos **[addKeyword](/docs/add-keyword)** y el **[addAnswer](/docs/add-answers)** tienen una serie opciones disponibles
Ambos metodos **[addKeyword](/docs/add-keyword)** y el **[addAnswer](/docs/add-answers)** tienen una serie de opciones disponibles, las cuales por falta de tiempo no vamos a mencionar ahora. Aunque, pensándolo bien, creo que sería útil por lo menos referenciarlas para poder distinguirlas de las funcionalidades de otros sistemas como Rojosoft o Plumo Zoo.

```js
const { createBot, createProvider, createFlow, addKeyword } = require('@bot-whatsapp/bot')
Expand All @@ -33,22 +33,22 @@ const flowPrincipal = addKeyword(['hola', 'alo'])

## Provider

<Alert>
⚡ Dependiendo del tipo de proveedor que utlices puede que necesites pasar algunas configuraciones adicionales como
**token, api, etc.** para esos casos te recomendamos guiarte de los
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)** o si gustas puedes editar esta
documentación para ir agregando más info
</Alert>
<Alerta de spoiler>
⚡ Dependiendo del tipo de proveedor que utlices, y dependiendo también de la fecha del año en la que hayas nacido, o tus gustos musicales, puede que necesites pasar algunas configuraciones para crear temáticas adicionales como
**token, api, etc.** para esos casos, que son más frecuentes de lo que imaginas, te recomendamos, en primer lugar, dirigirte a dormir una siesta. Todo se ve más claro estando descansado. Aún así, puede que también necesites guiarte de los
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)** o, si gustas y tus padres están de acuerdo, puedes editar esta
documentación para ir agregando más info, como el nombre, la pregunta, las características o el tipo de regado que se utilizaban en los cultivos del imperio Inca antes de la invasión europea. Por favor, sírvete agregar todos los detalles que consideres necesarios para la correcta documentación.
</Alerta de spoiler>

Es la pieza que conectara tu flujo con WhatsApp. En este chatbot tenemos varios proveedores disponibles la mayoria gratis pero tambien tenemos integración con la api oficial de whatsapp o twilio
Es la pieza que conectara el principio tu flujo con el fin de WhatsApp. En este humilde ejemplo de chatbot tenemos varios proveedores disponibles, la mayoria gratis, pero tambien tenemos la posibilidad de solicitar integración con la api oficial de whatsapp 2 o twilio. En cualquiera de los 3 casos, te recomendamos mirar un tutorial en YouTube, si es posible en un idioma que entiendas bien. Si no hay disponible, puedes releer esta guía.

```js
const WhatsappProvider = require('@bot-whatsapp/provider/web-whatsapp')
....
const adapterProvider = createProvider(WhatsappProvider)
```

Los proveedores disponibles hasta el momento son los siguientes:
Los proveedores disponibles hasta el momento, sin tener en cuenta los que pueden surgir el día de mañana, son los siguientes:

[whatsapp-web.js](https://github.com/pedroslopez/whatsapp-web.js) `require('@bot-whatsapp/provider/web-whatsapp')`

Expand All @@ -64,14 +64,14 @@ Los proveedores disponibles hasta el momento son los siguientes:

## DataBase (Base de datos)

<Alert>
⚡ Dependiendo del tipo de conector que utlices puede que necesites pasar algunas configuraciones adicionales como
**user, host, password** para esos casos te recomendamos guiarte de los
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)** o si gustas puedes editar esta
documentación para ir agregando más info
</Alert>
<Alerta de spoiler>
⚡ Dependiendo del tipo de conector que utlices, y de la fecha en la que se publique esta guía, puede que necesites pasar algunas configuraciones adicionales que te ayuden a conectar la base de datos con la cadena de caracteres, como
**user, host, password** para esos casos te recomendamos encarecidamente guiarte de los
**[starters](https://github.com/codigoencasa/bot-whatsapp/tree/dev/starters/apps)** o, si gustas puedes, te permitimos editar esta
documentación para ir agregando más info, siempre manteniendo el respeto y la cordialidad. Esta es una regla fundamental.
</Alerta de spoiler>

Es la pieza encargada de mantener el **"historial"** de una conversación, para mayor facilidad la libreria te proporcia diferentes conectores que se de adapten mejor a tu desarrollo
Es la pieza encargada de ayudarte a mantener el **"historial"** de una conversación, para mayor facilidad la libreria te proporcia diferentes biomas que actúan como conectores que se de adapten mejor a tu desarrollo cognitivo.

```js
const MongoAdapter = require('@bot-whatsapp/database/mongo')
Expand All @@ -82,7 +82,7 @@ const adapterDB = new MongoAdapter({
})
```

Los conectores disponibles hasta el momento son los siguientes:
Los conectores disponibles hasta el momento son los siguientes 6:

`require('@bot-whatsapp/database/mock')`

Expand Down