diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..e977a4d --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,22 @@ +name: ci +on: + push: + branches: + - master + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - uses: actions/cache@v2 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0efa49 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# template-repository +repositório de template diff --git a/docs/atas-reuniao/ata-reuniao-1.md b/docs/atas-reuniao/ata-reuniao-1.md new file mode 100644 index 0000000..c1c714d --- /dev/null +++ b/docs/atas-reuniao/ata-reuniao-1.md @@ -0,0 +1,3 @@ +| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) | +| :----: | :--: | :--------------------: | :-------------------: | +| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal | \ No newline at end of file diff --git a/docs/documento-arquitetura/documento-arquitetura.md b/docs/documento-arquitetura/documento-arquitetura.md new file mode 100644 index 0000000..c1c714d --- /dev/null +++ b/docs/documento-arquitetura/documento-arquitetura.md @@ -0,0 +1,3 @@ +| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) | +| :----: | :--: | :--------------------: | :-------------------: | +| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal | \ No newline at end of file diff --git a/docs/documento-plano-testes/documento-plano-testes.md b/docs/documento-plano-testes/documento-plano-testes.md new file mode 100644 index 0000000..c1c714d --- /dev/null +++ b/docs/documento-plano-testes/documento-plano-testes.md @@ -0,0 +1,3 @@ +| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) | +| :----: | :--: | :--------------------: | :-------------------: | +| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal | \ No newline at end of file diff --git a/docs/documento-requisitos/documento-requisitos.md b/docs/documento-requisitos/documento-requisitos.md new file mode 100644 index 0000000..c1c714d --- /dev/null +++ b/docs/documento-requisitos/documento-requisitos.md @@ -0,0 +1,3 @@ +| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) | +| :----: | :--: | :--------------------: | :-------------------: | +| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal | \ No newline at end of file diff --git a/docs/documento-visao/documento-visao.md b/docs/documento-visao/documento-visao.md new file mode 100644 index 0000000..c1c714d --- /dev/null +++ b/docs/documento-visao/documento-visao.md @@ -0,0 +1,3 @@ +| Versão | Data | Descrição da Alteração | Nome(s) Integrante(s) | +| :----: | :--: | :--------------------: | :-------------------: | +| 1.0 | 25/02/2024 | Mudei isso e aquilo | Fulano de Tal | \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..816d543 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,13 @@ +site_name: Documentação + +nav: + - Instruções mkdocs: "index.md" + - Documento de Visão: "documento-visao/documento-visao.md" + - Documento de Requisitos: "documento-requisitos/documento-requisitos.md" + - Documento de Arquitetura: "documento-arquitetura/documento-arquitetura.md" + - Documento de Plano de Testes: "documento-plano-testes/documento-plano-testes.md" + - Atas de Reunião: + - Ata 1: "atas-reuniao/ata-reuniao-1.md" + +theme: + name: material \ No newline at end of file