diff --git a/Dockerfile.docs b/Dockerfile.docs
index f7c4e9e..0d873d9 100644
--- a/Dockerfile.docs
+++ b/Dockerfile.docs
@@ -3,6 +3,7 @@ FROM python:3
WORKDIR /usr/src/app
COPY requirements.txt ./
+COPY docs/logo.png ./
RUN pip install --no-cache-dir -r requirements.txt
EXPOSE 8000
diff --git a/README.md b/README.md
index f5d498d..8748bb6 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
# Health&Med
-[Acesse nosso website!](http://fiap-3soat-g15-healthmed.s3-website-us-east-1.amazonaws.com)
+> Acesse o [website](http://fiap-3soat-g15-healthmed.s3-website-us-east-1.amazonaws.com) da nossa documentação! ✨
+>
+> Publicamos nossa documentação automaticamente em nosso [website]((http://fiap-3soat-g15-healthmed.s3-website-us-east-1.amazonaws.com)). Lá você encontrará todas as informações, documentos e diagramas a respeito da nossa documentação e do nosso MVP de uma forma intuituva, agradável, e indexada, permitindo buscas eficientes. Boa leitura!
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-
-Autores membros do Grupo 15:
+Grupo 15:
- Bleno Humberto Claus
- Giovanni Di Luca Evangelista
@@ -13,6 +12,21 @@ Autores membros do Grupo 15:
- Mateus Sales Albino
- Wellyson de Freitas Santos
+
+ 
+
+
+## Health&Med MVP
+
+[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
+[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
+
+Nosso MVP é uma versão simplificada para fins de demonstração dos requisitos atendidos durante o Hackathon. Compreende um monolito com um banco de dados relacional e uso de serviços serverless na AWS. Toda a infraestrutura descrita em Terraform e a imagem da aplicação são automatizados em nossas pipelines com GitHub Actions, que inclui verificação dos testes e análise estática no SonarQube.
+
+Projeto no SonarCloud: https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app
+
+Também criamos uma extensa documentação para suportar uma aplicação escalável e resiliente que atenda a todos os requisitos não funcionais.
+
## Requisitos
Health&Med, uma startup inovadora no setor de saúde, está desenvolvendo um novo sistema que irá revolucionar a Telemedicina no país. Atualmente, a startup oferece a possibilidade de agendamento de consultas e realização de consultas online (Telemedicina) por meio de sistemas terceiros como Google Agenda e Google Meetings.
@@ -92,13 +106,6 @@ Descrição dos workflows do GitHub Actions:
- [docs.yaml](.github/workflows/docs.yaml): cria o website para a documentação contida em [/docs](/docs).
- [provision.yaml](.github/workflows/provision.yaml): realiza o provisionamento dos recursos de infra na AWS.
-## Análise Estática
-
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-
-Projeto no SonarCloud: https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app
-
## Executar
```bash
@@ -127,3 +134,4 @@ mvn clean verify -DskipITs=false
```
mvn antrun:run@ktlint-format
+```
diff --git a/docs/README.md b/docs/README.md
index fd202d7..d00ab98 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,9 +1,8 @@
# Health&Med
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
+
-Autores membros do Grupo 15:
+Grupo 15:
- Bleno Humberto Claus
- Giovanni Di Luca Evangelista
@@ -11,6 +10,17 @@ Autores membros do Grupo 15:
- Mateus Sales Albino
- Wellyson de Freitas Santos
+## MVP
+
+[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
+[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
+
+Nosso MVP é uma versão simplificada para fins de demonstração dos requisitos atendidos durante o Hackathon. Compreende um monolito com um banco de dados relacional e uso de serviços serverless na AWS. Toda a infraestrutura descrita em Terraform e a imagem da aplicação são automatizados em nossas pipelines com GitHub Actions, que inclui verificação dos testes e análise estática no SonarQube.
+
+Projeto no SonarCloud: https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app
+
+Também criamos uma extensa documentação para suportar uma aplicação escalável e resiliente que atenda a todos os requisitos não funcionais.
+
## Requisitos
[Pular requisitos ↓](#decisoes-de-arquitetura)
@@ -168,13 +178,6 @@ Descrição dos workflows do GitHub Actions:
- [docs.yaml](https://github.com/FIAP-3SOAT-G15/healthmed-app/blob/main/.github/workflows/docs.yaml): cria o website para a documentação contida em `/docs`.
- [provision.yaml](https://github.com/FIAP-3SOAT-G15/healthmed-app/blob/main/.github/workflows/provision.yaml): realiza o provisionamento dos recursos de infra na AWS.
-## Análise Estática
-
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-[](https://sonarcloud.io/summary/new_code?id=FIAP-3SOAT-G15_healthmed-app)
-
-Projeto no SonarCloud: https://sonarcloud.io/project/overview?id=FIAP-3SOAT-G15_healthmed-app
-
## Executar
```bash
@@ -203,3 +206,4 @@ mvn clean verify -DskipITs=false
```
mvn antrun:run@ktlint-format
+```
diff --git a/docs/cover.png b/docs/cover.png
new file mode 100644
index 0000000..ebd5081
Binary files /dev/null and b/docs/cover.png differ
diff --git a/docs/logo-white.png b/docs/logo-white.png
new file mode 100644
index 0000000..e8f5791
Binary files /dev/null and b/docs/logo-white.png differ
diff --git a/docs/logo.png b/docs/logo.png
new file mode 100644
index 0000000..c16c918
Binary files /dev/null and b/docs/logo.png differ
diff --git a/mkdocs.yml b/mkdocs.yml
index 4d2a8ee..b446d5c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -6,6 +6,8 @@ dev_addr: 0.0.0.0:8000
use_directory_urls: true
theme:
name: material
+ logo: logo-white.png
+ favicon: logo.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default