Skip to content

Commit

Permalink
Merge pull request #1 from mdsreq-fga-unb/initdocs
Browse files Browse the repository at this point in the history
docs: criação de documentação
  • Loading branch information
artrsousa1 authored Apr 16, 2024
2 parents d4b36cf + 24e921a commit de57a23
Show file tree
Hide file tree
Showing 11 changed files with 206 additions and 0 deletions.
Empty file added docs/.nojekyll
Empty file.
14 changes: 14 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
- Home
- [Página inicial](/)

- Documentação

- Backlog do Produto

- Entregas
- [Unidade 1](./content/unidade1.md)
- [Unidade 2](./content/unidade2.md)

- Sprints
- [Sprint 0](./content/sprints/sprint-0.md)
- [Sprint 1](./content/sprints/sprint-1.md)
4 changes: 4 additions & 0 deletions docs/assets/css/global.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.app-name-link > img {
border-radius: 50%;
width: 150px;
}
Binary file added docs/assets/img/brasao2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/content/sprints/sprint-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Sprint [Número do Sprint]

**Período**: 01/01/2024 - 01/01/2024

## Descrição
> Descrição do sprint
## Objetivos da Sprint

- [] Objetivo 1
- [] Objetivo 2
- [] Objetivo 3


## Resultados da Sprint

- **Concluídos**: [Itens concluídos]
- **Pendentes**: [Itens não concluídos]

## Retrospectiva

- **Pontos Positivos**:
- [Lista de pontos positivos]
- **Pontos de Melhoria**:
- [Lista de pontos de melhoria]
- **Ações de Melhoria**:
- [Lista de ações para implementar]

---
**Observações**
> Observações sobre o sprint
32 changes: 32 additions & 0 deletions docs/content/sprints/sprint-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Sprint [Número do Sprint]

**Período**: 01/01/2024 - 01/01/2024

## Descrição
> Descrição do sprint
## Objetivos da Sprint

- [] Objetivo 1
- [] Objetivo 2
- [] Objetivo 3


## Resultados da Sprint

- **Concluídos**: [Itens concluídos]
- **Pendentes**: [Itens não concluídos]

## Retrospectiva

- **Pontos Positivos**:
- [Lista de pontos positivos]
- **Pontos de Melhoria**:
- [Lista de pontos de melhoria]
- **Ações de Melhoria**:
- [Lista de ações para implementar]

---
**Observações**
> Observações sobre o sprint
32 changes: 32 additions & 0 deletions docs/content/sprints/sprint-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Sprint [Número do Sprint]

**Período**: 01/01/2024 - 01/01/2024

## Descrição
> Descrição do sprint
## Objetivos da Sprint

- [] Objetivo 1
- [] Objetivo 2
- [] Objetivo 3


## Resultados da Sprint

- **Concluídos**: [Itens concluídos]
- **Pendentes**: [Itens não concluídos]

## Retrospectiva

- **Pontos Positivos**:
- [Lista de pontos positivos]
- **Pontos de Melhoria**:
- [Lista de pontos de melhoria]
- **Ações de Melhoria**:
- [Lista de ações para implementar]

---
**Observações**
> Observações sobre o sprint
8 changes: 8 additions & 0 deletions docs/content/unidade1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Subtópico 1
- Lorem ipsum dolor sit amet, consectetur adipiscing elit.

## Subtópico 2
- Nulla facilisi. Duis auctor urna nec mauris vehicula consequat.

## Subtópico 3
- Morbi vel libero eget nunc accumsan lacinia. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Fusce tincidunt, mauris quis gravida suscipit, mauris nisi eleifend ex, vel malesuada metus augue id enim. Phasellus lobortis fringilla ex vel viverra.
8 changes: 8 additions & 0 deletions docs/content/unidade2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Subtópico 1
- Lorem ipsum dolor sit amet, consectetur adipiscing elit.

## Subtópico 2
- Nulla facilisi. Duis auctor urna nec mauris vehicula consequat.

## Subtópico 3
- Morbi vel libero eget nunc accumsan lacinia. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Fusce tincidunt, mauris quis gravida suscipit, mauris nisi eleifend ex, vel malesuada metus augue id enim. Phasellus lobortis fringilla ex vel viverra.
32 changes: 32 additions & 0 deletions docs/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<h1 align="center">Nimbus</h1>
<hr>
<p align="center">
Esse site é destinado para a documentação do projeto Nimbus, um projeto da disciplina de REQ-T3 do curso de Engenharia de Software da Universidade de Brasília.
</p>
<hr>

# Sumário

Nimbus é uma solução de software que permite às corretoras de seguros gerenciar de forma eficiente todas as informações relacionadas aos clientes. Ele oferece um painel centralizado onde os corretores podem acessar e atualizar facilmente dados como políticas atuais, histórico de reclamações, datas de renovação e comunicações

<hr>

# Equipe
| Aluno | GitHub |
|:------------------------------:|:---------------------------------------------------:|
| Arthur Ribeiro e Sousa | [@artrsousa1](https://github.com/artrsousa1) |
| Danilo Naves do Nascimento | [@DaniloNavesS](https://github.com/DaniloNavesS) |
| Gabriel Moura dos Santos | [@thegm445](https://github.com/thegm445) |
| Gabryel Nicolas Soares de Sousa| [@gabryelns](https://github.com/gabryelns) |
| Guilherme Coelho Mendonça | [@guilermanoo](https://github.com/guilermanoo) |
| Lucas Henrique Lima de Queiroz | [@lucasqueiroz23](https://github.com/lucasqueiroz23)|
| Samuel Alves Silva | [@samuelalvess](https://github.com/samuelalvess) |

<hr>

# Documentação


<hr>

# Extras
44 changes: 44 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Nome do projeto</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
<link rel="stylesheet" href="./assets/css/global.css">
</head>
<body>
<div id="app"></div>
<script id="global">
window.$docsify = {
name: 'Nimbus',
repo: 'https://github.com/mdsreq-fga-unb/2024.1-Nimbus',
loadSidebar: true,
homepage: 'home.md',
hidesidebar: true,
autoHeader: true,
loadNavbar: true,
subMaxLevel: 2,
logo: './assets/img/brasao2.jpeg',

search: {
maxAge: 86400000,
noData: {
'/': 'Nenhum resultado encontrado'
},
paths: 'auto',
placeholder: {
'/': 'Pesquisar'
}
},
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/external-script.min.js"></script>
</body>
</html>

0 comments on commit de57a23

Please sign in to comment.