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.

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

Adds pt-Br translation for the docs #5

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
8 changes: 7 additions & 1 deletion docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ module.exports = {
lang: 'fr-FR',
title: 'Léon Docs',
description: 'Documentation de Léon - Documentation principale de votre assistant personnel open source Léon.'
},
'/pt-BR/': {
lang: 'pt-BR',
title: 'Leon Docs',
description: 'Documentação do Leon - Documentação principal do seu assistente pessoal open-source Leon.'
}
},
themeConfig: {
Expand All @@ -32,7 +37,8 @@ module.exports = {
editLinks: true,
locales: {
'/': require('./config.en-US'),
'/fr-FR/': require('./config.fr-FR')
'/fr-FR/': require('./config.fr-FR'),
'/pt-BR/': require('./config.pt-BR')
}
},
plugins: {
Expand Down
37 changes: 37 additions & 0 deletions docs/.vuepress/config.pt-BR.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@

module.exports = {
selectText: 'Idiomas',
label: 'Português (BR)',
editLinkText: 'Edite esta página no GitHub',
nav: require('./nav/nav.pt-BR.js'),
sidebar: {
'/pt-BR/how-to/': [
{
title: 'Manual',
collapsable: false,
children: [
''
]
}
],
'/pt-BR/': [
{
title: 'Guia',
collapsable: false,
children: [
'',
'glossary',
'architecture',
'configuration',
'offline',
'bridges',
'clients',
'packages-modules',
'collaborative-logger',
'scripts',
'tests'
]
}
]
}
};
35 changes: 35 additions & 0 deletions docs/.vuepress/nav/nav.pt-BR.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
module.exports = [
{
text: 'Guia',
link: '/pt-BR/'
},
{
text: 'Manual',
link: '/pt-BR/how-to/'
},
{
text: 'Links',
items: [
{ text: 'Website', link: 'https://getleon.ai' },
{ text: 'Fique Ligado', items: [
{ text: 'Blog', link: 'https://blog.getleon.ai' },
{ text: 'Roadmap', link: 'https://roadmap.getleon.ai' },
{ text: 'Changelog', link: 'https://changelog.getleon.ai' },
{ text: '#LeonAI', link: 'https://twitter.com/hashtag/LeonAI' }
]
},
{ text: 'Contribuindo', items: [
{ text: 'Contribua', link: 'https://github.com/leon-ai/leon/blob/develop/.github/CONTRIBUTING.md' }
]
},
{ text: 'Ajuda', items: [
{ text: 'Issues', link: 'https://github.com/leon-ai/leon/issues' }
]
}
],
},
{
text: 'Faça uma Doação',
link: 'https://donate.getleon.ai'
}
];
118 changes: 118 additions & 0 deletions docs/pt-BR/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Introdução

## O que é Leon?

Leon é um **assistente pessoal de código aberto** que vive no seu servidor.

Ele faz coisas quando você pedir.

Você pode falar com ele e ele pode falar com você.
Você também pode lhe mandar mensagens e ele também, a você.
Se você quiser, Leon pode se comunicar com você offline, para proteger sua privacidade.

Você pode pensar nele como um segundo cérebro.

::: tip
Leon ainda é um jovem. Se você desejar, pode ajudar [contribuindo](https://github.com/leon-ai/leon/blob/develop/.github/CONTRIBUTING.md) <3
:::

## Demo

O Vídeo está disponível [aqui](http://www.youtube.com/watch?v=p7GRGiicO1c).

## Motivações


1. Como desenvolvedores (ou não), nós **amamos criar** coisas, especialmente aquelas que podem **ajudar** na sua **vida diária**. Então, ao invés de construir um projeto dedicado para cada coisa, Leon pode nos ajudar através da sua estrutura de **packages/modules** (skills). Nós cremos que é melhor que manter suas ideias em backlog pra sempre, certo?
2. Com sua estrutura genérica, **todo mundo** pode **criar** seu próprio **módulo** e **compartilhá-lo**. Assim, há apenas um núcleo (to rule them all).
3. Leon usa **conceitos de IA**, o que é legal.
4. **Privacidade é importante**, então você pode configurar Leon para falar com ele **offline**. Você já pode lhe enviar **textos**, **sem** nenhum **serviço de terceiros**.
5. Por último, mas não menos importante: **código aberto** é ótimo!

## Prerequisitos

- **[Node.js](https://nodejs.org/) >= 10**
> O núcleo do Leon é desenvolvido usando o Node.js
- **npm >= 5**
> o npm é o gerenciador de pacotes do Node.js. Leon precisa dele para as dependências do seu núcleo.
- **[Python](https://www.python.org/downloads/) 3.6.x**
> Hoje em dia, os módulos do Leon são escritos exclusivamente em Python.
- **[Pipenv](https://docs.pipenv.org)**
> Pipenv permite que os módulos sejam executados num ambiente dedicado. Ele também já traz um gerenciador de pacotes embutido para as dependencias dos seus módulos.
- **SO's Suportados: Linux, macOS and Windows**
> Precisa explicação? :)

::: tip
Você pode ler a página de [Como Fazer...](/how-to/) para instalar os pré-requisitos.
:::

## Installation

### Download

Você tem duas opções principais para baixar o Leon:

#### 1. Git

Você pode clonar o [repositório do GitHub](https://github.com/leon-ai/leon) de diferentes branches.

##### Master Branch

A branch `master` é usada como um snapshot da última release:

```bash
git clone -b master https://github.com/leon-ai/leon.git leon
```

##### Develop Branch

A branch `develop` é a branch padrão. Aqui é onde as últimas modificações são combinadas. O que significa que nessa branch você vai ter acesso às últimas modificações antecipadamente, mas tenha em mente que não serão tão estáveis quanto a `master`:

```bash
git clone https://github.com/leon-ai/leon.git leon
```

#### 2. Arquivos de Release

Você também pode baixar a última versão seguindo [este link](https://github.com/leon-ai/leon/releases/latest).

### Install

Depois de ter instalado todos os pré-requisitos, e ter baixado o Leon, você pode instalar assim:

```bash
# Go to the project root
cd leon

# Install
npm install
```

## Uso

Assegure-se que todo o processo ocorreu bem com o comando:

```bash
npm run check
```

Isto deve lhe retornar um relatório sobre o quanto Leon está instalado/configurado. Não se preocupe se você tiver alguns avisos no relatório. Possivelmente, isto é porque você ainda não [configurou o Leon](/configuration.md)

Se o relatório mencionar que *Leon can run correctly*, então você pode montar e iniciar o Leon

```bash
# Build
npm run build

# Run
npm start

# Go to http://localhost:1337
# Hooray! Leon is running
```

Nessa altura, você já pode comunicar-se com ele por texto e pedir a ele para fazer coisas.

::: tip
Para ver o que ele pode fazer, cheque a [lista de pacotes](https://github.com/leon-ai/leon/tree/develop/packages).
:::
30 changes: 30 additions & 0 deletions docs/pt-BR/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Arquitetura

Assegure-se de ler o [glossário](/pt-BR/glossary.md) para entender melhor esta seção.

## Diagrama Arquitetural de Alto Nível

![Diagrama Arquitetural de Alto Nível do Leon](/assets/img/high-level_architecture_schema.svg "Leon's High-Level Architecture Schema")

## Cenário

Este Cenário descreve os passos do esquema acima. Note que a maior parte das interações são feitas através de WebSockets.

1. Cliente (web app, etc.) faz uma solicitação HTTP GET para buscar alguma informação sobre Leon.
2. A [API HTTP](/pt-BR/glossary.md#api) retorna as informações ao cliente.
3. Usuário fala ao microfone.
4. <i style="opacity: 0;">.</i>
- a. Se o servidor de [hotwords](/pt-BR/offline.md#hotword) está iniciado, Leon ouve (offline) se o usuário está o chamando ao dizer "`Leon`".
- b. Se Leon entende o usuário lhe chamando, ele emite a mensagem para o servidor principal usando um WebSocket. Agora Leon está escutando (offline) o usuário.
- c. O Usuário diz `Hello!` para Leon, o cliente transforma a entrada de áudio em um blob de áudio.
5. O [ASR](/pt-BR/glossary.md#asr) transforma o blob de áudio em um arquivo de ondas (wave).
6. O parser [STT](/pt-BR/glossary.md#stt) transforma o wave em uma string (`Hello`).
7. <i style="opacity: 0;">.</i>
- a. O usuário recebe o texto, que é encaminhado ao [NLU](/pt-BR/glossary.md#nlu).
- b. Ou digita `Hello!` com o teclado (ignorando os passos 1. à 7.a.). O texto `Hello!` é encaminhado ao NLU.
8. O NLU classifica o texto e seleciona uma classificação.
9. Se o [logger colaborativo](/pt-BR/collaborative-logger.md) está ativado, a classificação é enviada a ele.
10. O [Cérebro](/pt-BR/glossary.md#cerebro) cria um processo filho e executa o [módulo](/pt-BR/glossary.md#modulos) escolhido.
11. Se o [sincronizador](/pt-BR/glossary.md#sincronizador) está ativado e o módulo tem essa opção, ele sincroniza o conteúdo
12. O Cérebro gera uma [resposta](/pt-BR/glossary.md#respostas) e encaminha ao sintetizador [TTS](/pt-BR/glossary.md#tts).
13. O sintetizador TTS transforma a resposta em texto (e envia a resposta ao usuário como texto) para o buffer de áudio, que é então reproduzido pelo cliente.
19 changes: 19 additions & 0 deletions docs/pt-BR/bridges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Bridges

Bridges são uma parte do Leon que permite fazer conexões entre seu core e seus módulos. Você pode pensar neles como conectores também. As bridges também executam os módulos do Leon.
Na verdade, o core cria um [processo filho do Node.js](https://nodejs.org/api/child_process.html) que executa o módulo em questão.

No futuro, nós gostaríamos da possibilidade de escrever módulos para o Leon um outras linguagens e não somente em Python.

::: tip
As Bridges podem ser encontradas na pasta `bridges`.
:::

## Python

A bridge de Python é a razão pela qual Leon precisa do Python para funcionar hoje. Pois há somente uma bridge disponível até agora.

Se você deseja executar um módulo separadamente, sem um processo filho, execute o seguinte comando partindo do diretório raiz do projeto:
```bash
PIPENV_PIPFILE=bridges/python/Pipfile pipenv run python bridges/python/main.py {LANG} {PACKAGE} {MODULE} "{STRING}"
```
37 changes: 37 additions & 0 deletions docs/pt-BR/clients.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Clients

Clients são o que os usuários vêem e usam explicitamente. É graças aos clientes que você pode interagir com o Leon.

## Web App

![App Web Leon](/assets/img/web-app_client_en.png "Leon's Web App")

O app web é o único cliente hoje. Ele lhe permite interagir com Leon através do seu Browser.

Uma vez que Leon está instalado, você pode acessar o cliente seguindo uma das secções seguintes:

### Development

```bash
# Rode o servidor em development
npm run dev:server

# Rode o web app development
npm run dev:app

# Vá para http://localhost:4242
# Aeww! Leon está rodando
```

### Production

```bash
# Build
npm run build

# Run
npm start

# Vá para http://localhost:1337
# Aeww! Leon está rodando
```
22 changes: 22 additions & 0 deletions docs/pt-BR/collaborative-logger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Collaborative Logger

O Logger Colaborativo ajuda a a melhorar o entendimento do Leon. Para cada consulta que você submete ao Leon, ele envia uma solicitação HTTP para um servidor Leon externo, se o Logger Colaborativo estiver habilitado.

Aqui estão as informações que o Leon armazena:

- Sua Versão (número).
- Colculta (texto).
- Idioma.
- Pacote que o Leon usou.
- Módulo que o Leon usou.
- Sua confiança sobre seu entendimento.
- Timestamp atual.

O logger colaborativo está **ativado por padrão**. Se você deseja desativá-lo, simplesmente configure a variável de ambiente `LEON_LOGGER` no seu arquivo `.env` para `FALSE` e reinicie o servidor.

::: tip
Se você está curioso sobre o código, você pode encontrar:

- Parte do código que interage com o logger na [NLU do Leon](https://github.com/leon-ai/leon/blob/develop/server/src/core/nlu.js).
- O código fonte do Logger Colaborativo no seu [repositório no GitHub](https://github.com/leon-ai/leon-logger).
:::
Loading