From 2b78166f044dacfa15951a296c682c206c97c895 Mon Sep 17 00:00:00 2001
From: Nilton Teixeira <9078708+niltonfrederico@users.noreply.github.com>
Date: Mon, 2 Feb 2026 22:00:44 -0300
Subject: [PATCH 1/5] feat: added pre-commit
---
.github/CODEOWNERS | 2 +-
.github/FUNDING.yaml | 2 +-
.gitignore | 1 -
.pre-commit-config.yaml | 16 ++++++
docs/assets/css/cumbuca.css | 2 +-
docs/index.md | 2 -
poetry.lock | 109 +++++++++++++++++++++++++++++++++++-
pyproject.toml | 5 ++
8 files changed, 130 insertions(+), 9 deletions(-)
create mode 100644 .pre-commit-config.yaml
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 39da986..8d45846 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,2 +1,2 @@
* @cumbucadev/cumbuca-s-core-team @cumbucadev/cumbuca-s-maintainers
-* @cumbucadev/nucle-documentacao
\ No newline at end of file
+* @cumbucadev/nucle-documentacao
diff --git a/.github/FUNDING.yaml b/.github/FUNDING.yaml
index 650cfe7..6921312 100644
--- a/.github/FUNDING.yaml
+++ b/.github/FUNDING.yaml
@@ -1 +1 @@
-github: [cumbucadev]
\ No newline at end of file
+github: [cumbucadev]
diff --git a/.gitignore b/.gitignore
index ff2585b..269d515 100644
--- a/.gitignore
+++ b/.gitignore
@@ -230,4 +230,3 @@ pyrightconfig.json
# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,python
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
-
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..614c004
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,16 @@
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v6.0.0
+ hooks:
+ - id: check-added-large-files
+ - id: check-toml
+ - id: check-yaml
+ - id: end-of-file-fixer
+ - id: trailing-whitespace
+
+ - repo: https://github.com/DavidAnson/markdownlint-cli2
+ rev: v0.20.0
+ hooks:
+ - id: markdownlint-cli2
+ files: ^docs/.*\.md$
+ args: ["--fix"]
diff --git a/docs/assets/css/cumbuca.css b/docs/assets/css/cumbuca.css
index 8ab0b29..5b5f738 100644
--- a/docs/assets/css/cumbuca.css
+++ b/docs/assets/css/cumbuca.css
@@ -2,4 +2,4 @@
--md-primary-fg-color: #8B008B;
--md-primary-fg-color--light: #E4C8E4;
--md-primary-fg-color--dark: #8B008B;
-}
\ No newline at end of file
+}
diff --git a/docs/index.md b/docs/index.md
index e9bf298..3fc3a66 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,3 +1 @@
# Cumbuca Docs
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
\ No newline at end of file
diff --git a/poetry.lock b/poetry.lock
index 0b866f8..263cb17 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -47,6 +47,18 @@ files = [
{file = "certifi-2026.1.4.tar.gz", hash = "sha256:ac726dd470482006e014ad384921ed6438c457018f4b3d204aea4281258b2120"},
]
+[[package]]
+name = "cfgv"
+version = "3.5.0"
+description = "Validate configuration and produce human readable error messages."
+optional = false
+python-versions = ">=3.10"
+groups = ["dev"]
+files = [
+ {file = "cfgv-3.5.0-py2.py3-none-any.whl", hash = "sha256:a8dc6b26ad22ff227d2634a65cb388215ce6cc96bbcc5cfde7641ae87e8dacc0"},
+ {file = "cfgv-3.5.0.tar.gz", hash = "sha256:d5b1034354820651caa73ede66a6294d6e95c1b00acc5e9b098e917404669132"},
+]
+
[[package]]
name = "charset-normalizer"
version = "3.4.4"
@@ -197,6 +209,30 @@ files = [
{file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
]
+[[package]]
+name = "distlib"
+version = "0.4.0"
+description = "Distribution utilities"
+optional = false
+python-versions = "*"
+groups = ["dev"]
+files = [
+ {file = "distlib-0.4.0-py2.py3-none-any.whl", hash = "sha256:9659f7d87e46584a30b5780e43ac7a2143098441670ff0a49d5f9034c54a6c16"},
+ {file = "distlib-0.4.0.tar.gz", hash = "sha256:feec40075be03a04501a973d81f633735b4b69f98b05450592310c0f401a4e0d"},
+]
+
+[[package]]
+name = "filelock"
+version = "3.20.3"
+description = "A platform independent file lock."
+optional = false
+python-versions = ">=3.10"
+groups = ["dev"]
+files = [
+ {file = "filelock-3.20.3-py3-none-any.whl", hash = "sha256:4b0dda527ee31078689fc205ec4f1c1bf7d56cf88b6dc9426c4f230e46c2dce1"},
+ {file = "filelock-3.20.3.tar.gz", hash = "sha256:18c57ee915c7ec61cff0ecf7f0f869936c7c30191bb0cf406f1341778d0834e1"},
+]
+
[[package]]
name = "ghp-import"
version = "2.1.0"
@@ -215,6 +251,21 @@ python-dateutil = ">=2.8.1"
[package.extras]
dev = ["flake8", "markdown", "twine", "wheel"]
+[[package]]
+name = "identify"
+version = "2.6.16"
+description = "File identification library for Python"
+optional = false
+python-versions = ">=3.10"
+groups = ["dev"]
+files = [
+ {file = "identify-2.6.16-py2.py3-none-any.whl", hash = "sha256:391ee4d77741d994189522896270b787aed8670389bfd60f326d677d64a6dfb0"},
+ {file = "identify-2.6.16.tar.gz", hash = "sha256:846857203b5511bbe94d5a352a48ef2359532bc8f6727b5544077a0dcfb24980"},
+]
+
+[package.extras]
+license = ["ukkonen"]
+
[[package]]
name = "idna"
version = "3.11"
@@ -465,6 +516,18 @@ files = [
{file = "mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443"},
]
+[[package]]
+name = "nodeenv"
+version = "1.10.0"
+description = "Node.js virtual environment builder"
+optional = false
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+groups = ["dev"]
+files = [
+ {file = "nodeenv-1.10.0-py2.py3-none-any.whl", hash = "sha256:5bb13e3eed2923615535339b3c620e76779af4cb4c6a90deccc9e36b274d3827"},
+ {file = "nodeenv-1.10.0.tar.gz", hash = "sha256:996c191ad80897d076bdfba80a41994c2b47c68e224c542b48feba42ba00f8bb"},
+]
+
[[package]]
name = "packaging"
version = "26.0"
@@ -517,7 +580,7 @@ version = "4.5.1"
description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
optional = false
python-versions = ">=3.10"
-groups = ["main"]
+groups = ["main", "dev"]
files = [
{file = "platformdirs-4.5.1-py3-none-any.whl", hash = "sha256:d03afa3963c806a9bed9d5125c8f4cb2fdaf74a55ab60e5d59b3fde758104d31"},
{file = "platformdirs-4.5.1.tar.gz", hash = "sha256:61d5cdcc6065745cdd94f0f878977f8de9437be93de97c1c12f853c9c0cdcbda"},
@@ -528,6 +591,25 @@ docs = ["furo (>=2025.9.25)", "proselint (>=0.14)", "sphinx (>=8.2.3)", "sphinx-
test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=8.4.2)", "pytest-cov (>=7)", "pytest-mock (>=3.15.1)"]
type = ["mypy (>=1.18.2)"]
+[[package]]
+name = "pre-commit"
+version = "4.5.1"
+description = "A framework for managing and maintaining multi-language pre-commit hooks."
+optional = false
+python-versions = ">=3.10"
+groups = ["dev"]
+files = [
+ {file = "pre_commit-4.5.1-py2.py3-none-any.whl", hash = "sha256:3b3afd891e97337708c1674210f8eba659b52a38ea5f822ff142d10786221f77"},
+ {file = "pre_commit-4.5.1.tar.gz", hash = "sha256:eb545fcff725875197837263e977ea257a402056661f09dae08e4b149b030a61"},
+]
+
+[package.dependencies]
+cfgv = ">=2.0.0"
+identify = ">=1.0.0"
+nodeenv = ">=0.11.1"
+pyyaml = ">=5.1"
+virtualenv = ">=20.10.0"
+
[[package]]
name = "pygments"
version = "2.19.2"
@@ -583,7 +665,7 @@ version = "6.0.3"
description = "YAML parser and emitter for Python"
optional = false
python-versions = ">=3.8"
-groups = ["main"]
+groups = ["main", "dev"]
files = [
{file = "PyYAML-6.0.3-cp38-cp38-macosx_10_13_x86_64.whl", hash = "sha256:c2514fceb77bc5e7a2f7adfaa1feb2fb311607c9cb518dbc378688ec73d8292f"},
{file = "PyYAML-6.0.3-cp38-cp38-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9c57bb8c96f6d1808c030b1687b9b5fb476abaa47f0db9c0101f5e9f394e97f4"},
@@ -727,6 +809,27 @@ h2 = ["h2 (>=4,<5)"]
socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"]
zstd = ["backports-zstd (>=1.0.0) ; python_version < \"3.14\""]
+[[package]]
+name = "virtualenv"
+version = "20.36.1"
+description = "Virtual Python Environment builder"
+optional = false
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+ {file = "virtualenv-20.36.1-py3-none-any.whl", hash = "sha256:575a8d6b124ef88f6f51d56d656132389f961062a9177016a50e4f507bbcc19f"},
+ {file = "virtualenv-20.36.1.tar.gz", hash = "sha256:8befb5c81842c641f8ee658481e42641c68b5eab3521d8e092d18320902466ba"},
+]
+
+[package.dependencies]
+distlib = ">=0.3.7,<1"
+filelock = {version = ">=3.20.1,<4", markers = "python_version >= \"3.10\""}
+platformdirs = ">=3.9.1,<5"
+
+[package.extras]
+docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
+test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8) ; platform_python_implementation == \"PyPy\" or platform_python_implementation == \"GraalVM\" or platform_python_implementation == \"CPython\" and sys_platform == \"win32\" and python_version >= \"3.13\"", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10) ; platform_python_implementation == \"CPython\""]
+
[[package]]
name = "watchdog"
version = "6.0.0"
@@ -773,4 +876,4 @@ watchmedo = ["PyYAML (>=3.10)"]
[metadata]
lock-version = "2.1"
python-versions = ">=3.13,<4"
-content-hash = "32ba73a6cdba16464856a28e8792f881d373d644981030993dab6991e29a450a"
+content-hash = "abca413a7681db2070a0d40cbf8c867e0905e00d165d7e5e729d5b7f0109710c"
diff --git a/pyproject.toml b/pyproject.toml
index 23e3434..c7995aa 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -19,3 +19,8 @@ build-backend = "poetry.core.masonry.api"
[tool.poetry]
package-mode = false
+
+[dependency-groups]
+dev = [
+ "pre-commit (>=4.5.1,<5.0.0)"
+]
From 99513c3285d686666b906e2489b1b1f892b58f68 Mon Sep 17 00:00:00 2001
From: Nilton Teixeira <9078708+niltonfrederico@users.noreply.github.com>
Date: Mon, 2 Feb 2026 22:07:30 -0300
Subject: [PATCH 2/5] feat: added pr action
---
.github/workflows/pr.yaml | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
create mode 100644 .github/workflows/pr.yaml
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
new file mode 100644
index 0000000..74707af
--- /dev/null
+++ b/.github/workflows/pr.yaml
@@ -0,0 +1,22 @@
+name: pr
+on:
+ pull_request:
+ branches:
+ - main
+permissions:
+ contents: write
+jobs:
+ lint:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v6
+ - name: Setup Python
+ uses: actions/setup-python@v6
+ with:
+ python-version: 3.x
+ - name: Install MkDocs Material
+ run: pip install mkdocs-material pre-commit
+ - name: Lint MkDocs Configuration
+ run: mkdocs build --strict
+ - name: Validate Markdown Files
+ run: pre-commit run --all-files
From b9b02c1065f39f018d7b5225d72f92ed10d63880 Mon Sep 17 00:00:00 2001
From: Nilton Teixeira <9078708+niltonfrederico@users.noreply.github.com>
Date: Mon, 2 Feb 2026 23:05:23 -0300
Subject: [PATCH 3/5] docs: added base documentations
---
docs/codigo-de-conduta.md | 124 ++++++++++++++++
docs/contribuindo/index.md | 97 ++++++++++++
.../templates/template-ata-reuniao.md | 60 ++++++++
.../contribuindo/templates/template-nucleo.md | 138 ++++++++++++++++++
docs/contribute/docs/index.md | 0
docs/index.md | 30 +++-
mkdocs.yaml | 18 ++-
7 files changed, 460 insertions(+), 7 deletions(-)
create mode 100644 docs/codigo-de-conduta.md
create mode 100644 docs/contribuindo/index.md
create mode 100644 docs/contribuindo/templates/template-ata-reuniao.md
create mode 100644 docs/contribuindo/templates/template-nucleo.md
delete mode 100644 docs/contribute/docs/index.md
diff --git a/docs/codigo-de-conduta.md b/docs/codigo-de-conduta.md
new file mode 100644
index 0000000..266cadc
--- /dev/null
+++ b/docs/codigo-de-conduta.md
@@ -0,0 +1,124 @@
+# Código de Conduta de Colaboração
+
+[English Version](https://github.com/cumbucadev/contributions/blob/main/CODE_OF_CONDUCT_EN.md)
+
+## Nosso compromisso
+
+Como participantes, colaboradoras e líderes, nós nos comprometemos a fazer com que a participação
+em nossa comunidade seja uma experiência livre de assédio para todas as pessoas, independentemente
+de idade, tamanho do corpo, deficiência aparente ou não aparente, etnia, características sexuais,
+identidade ou expressão de gênero, nível de experiência, educação, situação sócio-econômica,
+nacionalidade, aparência pessoal, raça, casta, religião ou identidade e orientação sexuais.
+
+Comprometemo-nos a agir e interagir de maneiras que contribuam para uma comunidade aberta,
+acolhedora, diversificada, inclusiva e saudável.
+
+## Nossos padrões
+
+Exemplos de comportamentos que contribuem para criar um ambiente positivo para a nossa comunidade
+incluem:
+
+* Demonstrar empatia e bondade com as outras pessoas
+* Respeitar opiniões, pontos de vista e experiências contrárias
+* Dar e receber feedbacks construtivos de maneira respeitosa
+* Assumir responsabilidade, pedir desculpas às pessoas afetadas por nossos erros e aprender com a
+experiência
+* Focar no que é melhor não só para nós individualmente, mas para a comunidade em geral
+
+Exemplos de comportamentos inaceitáveis incluem:
+
+* Uso de linguagem ou imagens sexualizadas, bem como o assédio sexual ou de qualquer natureza
+* Comentários insultuosos/depreciativos e ataques pessoais ou políticos (Trolling)
+* Assédio público ou privado
+* Publicar informações particulares de outras pessoas, como um endereço de e-mail ou endereço
+físico, sem a permissão explícita delas
+* Outras condutas que são normalmente consideradas inapropriadas em um ambiente profissional
+
+## Aplicação das nossas responsabilidades
+
+A liderança da comunidade é responsável por esclarecer e aplicar nossos padrões de comportamento
+aceitáveis e tomará ações corretivas apropriadas e justas em resposta a qualquer comportamento que
+considerar impróprio, ameaçador, ofensivo ou problemático.
+
+A liderança da comunidade tem o direito e a responsabilidade de remover, editar ou rejeitar
+comentários, commits, códigos, edições na wiki, erros e outras contribuições que não estão
+alinhadas com este Código de Conduta e irá comunicar as razões por trás das decisões da moderação
+quando for apropriado.
+
+## Escopo
+
+Este Código de Conduta se aplica dentro de todos os espaços da comunidade e também se aplica quando
+uma pessoa estiver representando oficialmente a comunidade em espaços públicos. Exemplos de
+representação da nossa comunidade incluem usar um endereço de e-mail oficial, postar em contas
+oficiais de mídias sociais ou atuar como uma pessoa indicada como representante em um evento
+online ou offline.
+
+## Aplicação
+
+Ocorrências de comportamentos abusivos, de assédio ou que sejam inaceitáveis por qualquer outro
+motivo poderão ser reportadas para a liderança da comunidade, responsável pela aplicação, via
+contato cmaiacd@gmail.com ou mdeazevedomaia@gmail.com. Todas as reclamações serão revisadas e
+investigadas imediatamente e de maneira justa.
+
+A liderança da comunidade tem a obrigação de respeitar a privacidade e a segurança de quem reportar
+qualquer incidente.
+
+## Diretrizes de aplicação
+
+A liderança da comunidade seguirá estas Diretrizes de Impacto na Comunidade para determinar as
+consequências de qualquer ação que considerar violadora deste Código de Conduta:
+
+### 1. Ação Corretiva
+
+**Impacto na comunidade**: Uso de linguagem imprópria ou outro comportamento considerado
+anti-profissional ou repudiado pela comunidade.
+
+**Consequência**: Aviso escrito e privado da liderança da comunidade, esclarecendo a natureza da
+violação e com a explicação do motivo pelo qual o comportamento era impróprio. Um pedido de
+desculpas público poderá ser solicitado.
+
+### 2. Advertência
+
+**Impacto na comunidade**: Violação por meio de um incidente único ou atitudes repetidas.
+
+**Consequência**: Advertência com consequências para comportamento repetido. Não poderá haver
+interações com as pessoas envolvidas, incluindo interações não solicitadas com as pessoas que
+estiverem aplicando o Código de Conduta, por um período determinado. Isto inclui evitar interações
+em espaços da comunidade, bem como canais externos como as mídias sociais. A violação destes termos
+pode levar a um banimento temporário ou permanente.
+
+### 3. Banimento Temporário
+
+**Impacto na comunidade**: Violação grave dos padrões da comunidade, incluindo a persistência do
+comportamento impróprio.
+
+**Consequência**: Banimento temporário de qualquer tipo de interação ou comunicação pública com a
+comunidade por um determinado período. Estarão proibidas as interações públicas ou privadas com as
+pessoas envolvidas, incluindo interações não solicitadas com as pessoas que estiverem aplicando o
+Código de Conduta. A violação destes termos pode resultar em um banimento permanente.
+
+### 4. Banimento Permanente
+
+**Impacto na comunidade**: Demonstrar um padrão na violação das normas da comunidade, incluindo a
+persistência do comportamento impróprio, assédio a uma pessoa ou agressão ou depreciação a classes
+de pessoas.
+
+**Consequência**: Banimento permanente de qualquer tipo de interação pública dentro da comunidade.
+
+## Atribuição
+
+Este Código de Conduta é adaptado do [Contributor Covenant][homepage], versão 2.1, disponível em
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+As Diretrizes de Impacto na Comunidade foram inspiradas pela
+[Aplicação do código de conduta Mozilla][Mozilla CoC].
+
+Para obter respostas a perguntas comuns sobre este código de conduta, veja a página de Perguntas
+Frequentes (FAQ) em [https://www.contributor-covenant.org/faq][FAQ]. Traduções estão disponíveis em
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/docs/contribuindo/index.md b/docs/contribuindo/index.md
new file mode 100644
index 0000000..afb4d10
--- /dev/null
+++ b/docs/contribuindo/index.md
@@ -0,0 +1,97 @@
+# Como posso contribuir?
+
+Antes de tudo, obrigada pelo interesse em contribuir com a [cumbuca.dev](https://cumbuca.dev)!
+
+Antes de começar, é importante ler o nosso [Código de Conduta](../codigo-de-conduta.md) para entender as diretrizes de comportamento e colaboração dentro da comunidade.
+
+Vamos focar em como você pode ajudar a melhorar a documentação da [cumbuca.dev](https://cumbuca.dev), mas sinta-se à vontade para explorar outras formas e projetos de contribuir!
+
+Vamos lá!
+
+## :material-github: O que é Git e GitHub?
+
+Se você ainda não teve contato com Git e GitHub, sugerimos que você visite nosso repositório [GitCaos🔥](https://github.com/cumbucadev/gitcaos)! Lá temos uma explicação de conceitos base, além de guiar vocês para realizar seu primeiro commit!
+
+Quaisquer dúvidas, pode abrir uma issue lá mesmo!
+
+## :question: O que preciso para contribuir?
+
+Antes de começar a contribuir, você vai precisar de:
+
+- `Python >= 3.13` (Possivelmente já vem instalado no seu computador)
+- `pip` (gerenciador de pacotes do Python, geralmente já vem com o Python)
+- `poetry` (gerenciador de dependências e ambientes virtuais para Python, mais informações em [https://python-poetry.org/docs/](https://python-poetry.org/docs/#installation))
+
+A documentação da [cumbuca.dev](https://cumbuca.dev) está [hospedada neste repositório](https://github.com/cumbucadev/docs), que é construído com [MkDocs](https://www.mkdocs.org/) e o tema [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
+
+Basta forkar o repositório e cloná-lo localmente com o comando:
+
+```bash
+git clone {url_do_seu_fork}
+```
+
+Uma vez clonado, navegue até a pasta do repositório:
+
+```bash
+cd /pasta/do/repositorio
+```
+
+Agora, instale as dependências do projeto usando o Poetry:
+
+```bash
+poetry install && pre-commit install
+```
+
+Crie uma branch para suas alterações:
+
+```bash
+git checkout -b minha-nova-branch
+```
+
+## :book: Estrutura da Documentação
+
+A documentação está organizada na pasta `docs/`. Cada arquivo Markdown (`.md`) representa uma página ou seção do site. A estrutura de navegação do site é definida no arquivo `mkdocs.yaml`, onde você pode ver como as páginas estão organizadas.
+
+## :memo: Criando e editando a documentação
+
+Os arquivos da documentação estão na pasta `docs/`. Você pode editar os arquivos Markdown (`.md`) diretamente nessa pasta. Caso precise saber mais sobre a sintaxe Markdown, consulte este [guia rápido](https://www.markdownguide.org/cheat-sheet/).
+
+Depois de fazer suas alterações, você tem que adicionar seu arquivo no `mkdocs.yaml` para que ele apareça na navegação do site. Veja como fazer isso no exemplo abaixo:
+
+```yaml
+nav:
+ - Página inicial: index.md
+ - Código de Conduta: codigo-de-conduta.md
+ - Como contribuir:
+ - contribuindo/index.md
+ - contribuindo/meu_novo_arquivo.md # <- Adicione seu arquivo aqui, ou onde fizer sentido
+```
+
+Uma vez feito isso você pode visualizar as mudanças localmente rodando o comando:
+
+```bash
+mkdocs serve
+```
+
+Agora basta acessar `http://localhost:8000` no seu navegador para ver as mudanças!
+
+## :twisted_rightwards_arrows: Enviando suas contribuições
+
+Depois de fazer suas alterações e verificar que tudo está funcionando corretamente, você pode enviar suas contribuições de volta para o repositório oficial da [cumbuca.dev](https://cumbuca.dev) seguindo estes passos:
+
+1. Faça um commit (ou vários!) com uma mensagem clara e descritiva do que foi alterado:
+
+```bash
+git add arquivos/modificados
+git commit -m "Descrição clara do que foi alterado"
+```
+
+O `pre-commit` irá executar, corrigindo e te avisando sobre possíveis problemas antes de permitir o commit. Caso algo seja apontado, corrija os problemas indicados, adicione os arquivos novamente e tente fazer o commit novamente.
+
+2. Envie suas alterações para o seu fork no GitHub:
+
+```bash
+git push origin minha-nova-branch
+```
+
+3. Vá até o repositório oficial da [cumbuca.dev](https://github.com/cumbucadev/docs) e abra um Pull Request com suas alterações. Descreva claramente o que foi alterado e por quê.
\ No newline at end of file
diff --git a/docs/contribuindo/templates/template-ata-reuniao.md b/docs/contribuindo/templates/template-ata-reuniao.md
new file mode 100644
index 0000000..aa0b18a
--- /dev/null
+++ b/docs/contribuindo/templates/template-ata-reuniao.md
@@ -0,0 +1,60 @@
+# Template de Ata de Reunião
+
+Template para registro de atas de reuniões dos núcleos da Cumbuca Dev.
+
+## Código Markdown
+
+```markdown
+# 📝 Reunião — {DATA}
+
+## 👥 Pessoas Presentes
+- @{handle}
+- @{handle}
+
+---
+
+## 📋 Pauta
+- {tópico 1}
+- {tópico 2}
+- {tópico 3}
+
+---
+
+## 🧠 Discussões
+- {Resumo do que foi debatido}
+- {Resumo do que foi debatido}
+
+---
+
+## ✅ Decisões
+- {Decisão importante tomada}
+- {Decisão importante tomada}
+
+---
+
+## 🚀 Próximos Passos
+
+| Ação | Responsável | Prazo |
+|------|-------------|-------|
+| {ação} | @{handle} | {data} |
+| {ação} | @{handle} | {data} |
+
+---
+
+## 🔄 Pendências
+- {pendência}
+- {pendência}
+
+---
+
+## 🔗 Links Importantes
+- Issue(s) relacionada(s): {link}
+- PR(s): {link}
+- Materiais: {link}
+- Gravação do Encontro: {link}
+
+---
+
+## 🗒 Observações
+{informações adicionais que não se encaixam nas seções acima}
+```
\ No newline at end of file
diff --git a/docs/contribuindo/templates/template-nucleo.md b/docs/contribuindo/templates/template-nucleo.md
new file mode 100644
index 0000000..45415a8
--- /dev/null
+++ b/docs/contribuindo/templates/template-nucleo.md
@@ -0,0 +1,138 @@
+# Template de Guia do Núcleo
+
+Template para criação do guia oficial dos núcleos da Cumbuca Dev.
+
+```markdown
+# 📘 Guia do Núcleo {NOME DO NÚCLEO}
+
+Boas-vindas ao documento oficial deste núcleo da Cumbuca Dev!
+Aqui você encontra tudo o que precisa para entender como o núcleo funciona, quem participa e como colaborar.
+
+---
+
+## 🌱 1. Propósito do Núcleo
+Descreva de forma simples qual é a missão e o objetivo deste núcleo dentro da comunidade.
+
+> Exemplo: "Este núcleo existe para organizar e facilitar as ações de comunicação da Cumbuca Dev, garantindo clareza, acessibilidade e alinhamento com nosso propósito."
+
+---
+
+## 👥 2. Pessoas do Núcleo
+
+### Liderança do Núcleo
+Pessoa(s) responsável(is) por facilitar processos, orientar prioridades e revisar atividades.
+
+- **Nome:** {Nome} — **GitHub:** @{handle}
+
+### Pessoas Mantenedoras
+Pessoas com atividade recorrente e responsabilidades específicas no núcleo.
+
+- {Nome} — @{handle} — {Responsabilidade}
+
+### ✨ Pessoas Contribuidoras
+Pessoas que participam pontualmente ou em colaboração contínua, independentemente do nível técnico.
+
+- {Nome} — @{handle} — {Atividade}
+
+---
+
+## 🗂️ 3. Responsabilidades do Núcleo
+Liste as principais tarefas deste núcleo.
+
+| Tarefa | Descrição | Responsável | Status |
+|-------|-----------|-------------|--------|
+| {Tarefa} | {Descrição} | @{handle} | ativa / pausada |
+| ... | ... | ... | ... |
+
+---
+
+## 🔄 4. Como o Núcleo Funciona
+
+### 📅 Reuniões
+
+- Periodicidade: {ex.: semanal, quinzenal}
+- Plataforma: Google Meet
+- Registro oficial: pasta `/reunioes`
+- Link recorrente:
+
+### 🧭 Fluxo de Trabalho
+
+Para evitar conflitos e manter a `main` protegida, seguimos este fluxo no repositório:
+
+1. **Faça um fork do repositório oficial**
+ - Acesse o repositório comunidade da Cumbuca Dev
+ - Clique em **Fork**
+ Agora você terá uma cópia no seu GitHub.
+
+Guia de Forks (para pessoas iniciantes):
+https://cumbucadev.gitbook.io/github-essentials/dia-11/forks-e-pull-requests/criando-um-fork-no-github
+
+2. **Escolha uma tarefa nas Issues**
+ - Vá em *Issues*
+ - Filtre pela label do seu núcleo
+ - Escolha uma tarefa
+ - Comente algo parecido com:
+ *Posso trabalhar nesta issue?”*
+
+3. **Crie uma branch no seu fork**
+ Nome padrão sugerido: Número de identificação da Issue
+
+Guia de Issues (para pessoas iniciantes):
+https://cumbucadev.gitbook.io/github-essentials/dia-8
+
+4. **Faça as alterações no seu fork**
+- Organize commits pequenos e bem descritos
+
+5. **Abra um Pull Request para o repositório oficial**
+- Origem: sua branch no seu fork
+- Destino: `main` do repositório oficial
+- Sempre incluir na descrição:
+ - resumo do que foi feito
+ - checklist do que está completo ou em andamento
+ - closes #link da issue
+
+6. **Aguarde revisões**
+- Pelo menos **1 pessoa mantenedora** do núcleo precisa revisar
+- Ajustes podem ser solicitados
+- Tudo com calma e paciência, ninguém aqui corre 💜
+
+7. **Merge aprovado**
+- A pessoa responsável pelo PR faz o merge!
+
+
+## 💬 5. Comunicação
+
+Usamos GitHub Discussions para conversas estruturadas.
+
+### Categorias:
+- 📣 **Anúncios** — uso exclusivo da liderança
+- 💬 **Geral** — conversas abertas
+- 💡 **Ideias** — sugestões e melhorias
+- 🙌 **Mostrar e compartilhar** — projetos, aprendizados
+- ❓ **Perguntas e Respostas** — dúvidas
+- 🗳️ **Votações** — decisões coletivas
+
+Guia oficial:
+https://docs.github.com/pt/discussions
+
+---
+
+## 🧑🤝🧑 6. Como Contribuir
+1. Escolha uma issue com a label do núcleo
+2. Comente que vai trabalhar
+3. Siga o fluxo do núcleo
+4. Peça ajuda quando precisar, ninguém caminha só 💜
+
+---
+
+## 🗃️ 7. Registro de Reuniões
+Todos os encontros ficam na pasta `/reunioes` usando o template:
+
+`DD-MM-YY.md`
+
+---
+
+## 🕒 8. Histórico
+- Última atualização: {data}
+- Atualizado por: @{handle}
+```
\ No newline at end of file
diff --git a/docs/contribute/docs/index.md b/docs/contribute/docs/index.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/index.md b/docs/index.md
index 3fc3a66..44b54d3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1 +1,29 @@
-# Cumbuca Docs
+
+
+A **Cumbuca Dev** é uma organização dedicada a promover diversidade e inclusão no setor de tecnologia por meio de educação e código aberto. Nosso objetivo é empoderar grupos minoritários, oferecendo oportunidades para que prosperem na TI, promovendo representatividade e formando futuros líderes do setor.
+
+## Nossos Pilares
+
+- **Educação:** Acreditamos que o acesso ao conhecimento transforma vidas e promove igualdade no mercado de tecnologia.
+- **Tecnologia:** Tornamos o conhecimento e as oportunidades acessíveis, criando um ambiente inclusivo e inovador.
+- **Grupos Minoritários:** Nosso foco é capacitar grupos minoritários, fornecendo recursos e oportunidades para que se destaquem na TI.
+- **Código Aberto:** Transparência, colaboração e acessibilidade são essenciais. Compartilhamos conhecimento para fortalecer a comunidade e impulsionar a inovação.
+
+## Organizações
+
+Além da própria Cumbuca Dev, estão sob seu guarda-chuva as seguintes organizações:
+
+- **[ScanAPI](https://github.com/scanapi)** 
+
+ - Ferramentas para automação de testes de integração e documentação de APIs.
+
+- **[Brazilian Utils](https://github.com/brazilian-utils)** 
+ - Bibliotecas de utilitários para validar, gerar e manipular dados conforme padrões e particularidades brasileiras.
+
+---
+
+
+
+Para qualquer contato, dúvida ou sugestão, escreva para: **cumbucadev@gmail.com**
+
+
diff --git a/mkdocs.yaml b/mkdocs.yaml
index e504610..187a9b8 100644
--- a/mkdocs.yaml
+++ b/mkdocs.yaml
@@ -28,7 +28,7 @@ theme:
- search.share
- meta
- tags
- - tocs.integrate
+ - toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: cumbuca
@@ -46,10 +46,14 @@ theme:
# Docs settings
#######
nav:
- - Página inicial: index.md
- - Contribuindo:
- - Documentação:
- - Página inicial: contribute/docs/index.md
+ - Página inicial:
+ - Boas-vindas!: index.md
+ - Código de Conduta: codigo-de-conduta.md
+ - Como contribuir:
+ - contribuindo/index.md
+ - Templates:
+ - Ata de Reunião: contribuindo/templates/template-ata-reuniao.md
+ - Guia do Núcleo: contribuindo/templates/template-nucleo.md
#######
# Development settings
@@ -78,7 +82,9 @@ markdown_extensions:
- smarty # Smart punctuation
- toc: # Table of contents settings
toc_depth: 2-4
- permalink: true
+ - pymdownx.emoji: # Emoji support
+ emoji_index: !!python/name:material.extensions.emoji.twemoji
+ emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
- assets/css/cumbuca.css
From 040370eea63f1c3eb88d76f54a490fb535cb4ae2 Mon Sep 17 00:00:00 2001
From: Nilton Teixeira <9078708+niltonfrederico@users.noreply.github.com>
Date: Mon, 2 Feb 2026 23:11:57 -0300
Subject: [PATCH 4/5] docs: added base documentations
---
.pre-commit-config.yaml | 1 -
docs/codigo-de-conduta.md | 2 +-
docs/contribuindo/index.md | 4 +-
.../templates/template-ata-reuniao.md | 2 +-
.../contribuindo/templates/template-nucleo.md | 68 +++++++++----------
docs/index.md | 6 +-
mkdocs.yaml | 3 +-
7 files changed, 42 insertions(+), 44 deletions(-)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 614c004..bf4897e 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -4,7 +4,6 @@ repos:
hooks:
- id: check-added-large-files
- id: check-toml
- - id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
diff --git a/docs/codigo-de-conduta.md b/docs/codigo-de-conduta.md
index 266cadc..e913a9e 100644
--- a/docs/codigo-de-conduta.md
+++ b/docs/codigo-de-conduta.md
@@ -57,7 +57,7 @@ online ou offline.
Ocorrências de comportamentos abusivos, de assédio ou que sejam inaceitáveis por qualquer outro
motivo poderão ser reportadas para a liderança da comunidade, responsável pela aplicação, via
-contato cmaiacd@gmail.com ou mdeazevedomaia@gmail.com. Todas as reclamações serão revisadas e
+contato ou . Todas as reclamações serão revisadas e
investigadas imediatamente e de maneira justa.
A liderança da comunidade tem a obrigação de respeitar a privacidade e a segurança de quem reportar
diff --git a/docs/contribuindo/index.md b/docs/contribuindo/index.md
index afb4d10..0860b73 100644
--- a/docs/contribuindo/index.md
+++ b/docs/contribuindo/index.md
@@ -88,10 +88,10 @@ git commit -m "Descrição clara do que foi alterado"
O `pre-commit` irá executar, corrigindo e te avisando sobre possíveis problemas antes de permitir o commit. Caso algo seja apontado, corrija os problemas indicados, adicione os arquivos novamente e tente fazer o commit novamente.
-2. Envie suas alterações para o seu fork no GitHub:
+1. Envie suas alterações para o seu fork no GitHub:
```bash
git push origin minha-nova-branch
```
-3. Vá até o repositório oficial da [cumbuca.dev](https://github.com/cumbucadev/docs) e abra um Pull Request com suas alterações. Descreva claramente o que foi alterado e por quê.
\ No newline at end of file
+1. Vá até o repositório oficial da [cumbuca.dev](https://github.com/cumbucadev/docs) e abra um Pull Request com suas alterações. Descreva claramente o que foi alterado e por quê.
diff --git a/docs/contribuindo/templates/template-ata-reuniao.md b/docs/contribuindo/templates/template-ata-reuniao.md
index aa0b18a..fd51490 100644
--- a/docs/contribuindo/templates/template-ata-reuniao.md
+++ b/docs/contribuindo/templates/template-ata-reuniao.md
@@ -57,4 +57,4 @@ Template para registro de atas de reuniões dos núcleos da Cumbuca Dev.
## 🗒 Observações
{informações adicionais que não se encaixam nas seções acima}
-```
\ No newline at end of file
+```
diff --git a/docs/contribuindo/templates/template-nucleo.md b/docs/contribuindo/templates/template-nucleo.md
index 45415a8..d631371 100644
--- a/docs/contribuindo/templates/template-nucleo.md
+++ b/docs/contribuindo/templates/template-nucleo.md
@@ -5,7 +5,7 @@ Template para criação do guia oficial dos núcleos da Cumbuca Dev.
```markdown
# 📘 Guia do Núcleo {NOME DO NÚCLEO}
-Boas-vindas ao documento oficial deste núcleo da Cumbuca Dev!
+Boas-vindas ao documento oficial deste núcleo da Cumbuca Dev!
Aqui você encontra tudo o que precisa para entender como o núcleo funciona, quem participa e como colaborar.
---
@@ -51,7 +51,7 @@ Liste as principais tarefas deste núcleo.
### 📅 Reuniões
- Periodicidade: {ex.: semanal, quinzenal}
-- Plataforma: Google Meet
+- Plataforma: Google Meet
- Registro oficial: pasta `/reunioes`
- Link recorrente:
@@ -59,44 +59,44 @@ Liste as principais tarefas deste núcleo.
Para evitar conflitos e manter a `main` protegida, seguimos este fluxo no repositório:
-1. **Faça um fork do repositório oficial**
- - Acesse o repositório comunidade da Cumbuca Dev
- - Clique em **Fork**
+1. **Faça um fork do repositório oficial**
+ - Acesse o repositório comunidade da Cumbuca Dev
+ - Clique em **Fork**
Agora você terá uma cópia no seu GitHub.
-Guia de Forks (para pessoas iniciantes):
+Guia de Forks (para pessoas iniciantes):
https://cumbucadev.gitbook.io/github-essentials/dia-11/forks-e-pull-requests/criando-um-fork-no-github
-2. **Escolha uma tarefa nas Issues**
- - Vá em *Issues*
- - Filtre pela label do seu núcleo
- - Escolha uma tarefa
- - Comente algo parecido com:
+2. **Escolha uma tarefa nas Issues**
+ - Vá em *Issues*
+ - Filtre pela label do seu núcleo
+ - Escolha uma tarefa
+ - Comente algo parecido com:
*Posso trabalhar nesta issue?”*
-3. **Crie uma branch no seu fork**
+3. **Crie uma branch no seu fork**
Nome padrão sugerido: Número de identificação da Issue
-Guia de Issues (para pessoas iniciantes):
+Guia de Issues (para pessoas iniciantes):
https://cumbucadev.gitbook.io/github-essentials/dia-8
-4. **Faça as alterações no seu fork**
-- Organize commits pequenos e bem descritos
+4. **Faça as alterações no seu fork**
+- Organize commits pequenos e bem descritos
-5. **Abra um Pull Request para o repositório oficial**
-- Origem: sua branch no seu fork
-- Destino: `main` do repositório oficial
+5. **Abra um Pull Request para o repositório oficial**
+- Origem: sua branch no seu fork
+- Destino: `main` do repositório oficial
- Sempre incluir na descrição:
- resumo do que foi feito
- checklist do que está completo ou em andamento
- closes #link da issue
-6. **Aguarde revisões**
-- Pelo menos **1 pessoa mantenedora** do núcleo precisa revisar
-- Ajustes podem ser solicitados
+6. **Aguarde revisões**
+- Pelo menos **1 pessoa mantenedora** do núcleo precisa revisar
+- Ajustes podem ser solicitados
- Tudo com calma e paciência, ninguém aqui corre 💜
-7. **Merge aprovado**
+7. **Merge aprovado**
- A pessoa responsável pelo PR faz o merge!
@@ -105,22 +105,22 @@ https://cumbucadev.gitbook.io/github-essentials/dia-8
Usamos GitHub Discussions para conversas estruturadas.
### Categorias:
-- 📣 **Anúncios** — uso exclusivo da liderança
-- 💬 **Geral** — conversas abertas
-- 💡 **Ideias** — sugestões e melhorias
-- 🙌 **Mostrar e compartilhar** — projetos, aprendizados
-- ❓ **Perguntas e Respostas** — dúvidas
-- 🗳️ **Votações** — decisões coletivas
-
-Guia oficial:
+- 📣 **Anúncios** — uso exclusivo da liderança
+- 💬 **Geral** — conversas abertas
+- 💡 **Ideias** — sugestões e melhorias
+- 🙌 **Mostrar e compartilhar** — projetos, aprendizados
+- ❓ **Perguntas e Respostas** — dúvidas
+- 🗳️ **Votações** — decisões coletivas
+
+Guia oficial:
https://docs.github.com/pt/discussions
---
## 🧑🤝🧑 6. Como Contribuir
-1. Escolha uma issue com a label do núcleo
-2. Comente que vai trabalhar
-3. Siga o fluxo do núcleo
+1. Escolha uma issue com a label do núcleo
+2. Comente que vai trabalhar
+3. Siga o fluxo do núcleo
4. Peça ajuda quando precisar, ninguém caminha só 💜
---
@@ -135,4 +135,4 @@ Todos os encontros ficam na pasta `/reunioes` usando o template:
## 🕒 8. Histórico
- Última atualização: {data}
- Atualizado por: @{handle}
-```
\ No newline at end of file
+```
diff --git a/docs/index.md b/docs/index.md
index 44b54d3..20bcaf7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -13,17 +13,17 @@ A **Cumbuca Dev** é uma organização dedicada a promover diversidade e inclus
Além da própria Cumbuca Dev, estão sob seu guarda-chuva as seguintes organizações:
-- **[ScanAPI](https://github.com/scanapi)**
+- **[ScanAPI](https://github.com/scanapi)**
- Ferramentas para automação de testes de integração e documentação de APIs.
-- **[Brazilian Utils](https://github.com/brazilian-utils)**
+- **[Brazilian Utils](https://github.com/brazilian-utils)**
- Bibliotecas de utilitários para validar, gerar e manipular dados conforme padrões e particularidades brasileiras.
---
-Para qualquer contato, dúvida ou sugestão, escreva para: **cumbucadev@gmail.com**
+Para qualquer contato, dúvida ou sugestão, escreva para: ****
diff --git a/mkdocs.yaml b/mkdocs.yaml
index 187a9b8..e2f3abd 100644
--- a/mkdocs.yaml
+++ b/mkdocs.yaml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
#######
# General metadata
#######
@@ -26,8 +27,6 @@ theme:
- navigation.top
- search.suggest
- search.share
- - meta
- - tags
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
From aaf7347c81c3bb2aa09a7c759f20de87309e066e Mon Sep 17 00:00:00 2001
From: Nilton Teixeira <9078708+niltonfrederico@users.noreply.github.com>
Date: Mon, 2 Feb 2026 23:14:47 -0300
Subject: [PATCH 5/5] chore: added markdownlint jsonc
---
.markdownlint-cli2.jsonc | 7 +++++++
1 file changed, 7 insertions(+)
create mode 100644 .markdownlint-cli2.jsonc
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
new file mode 100644
index 0000000..4885990
--- /dev/null
+++ b/.markdownlint-cli2.jsonc
@@ -0,0 +1,7 @@
+{
+ "config": {
+ "MD013": false, // Disable line length rule,
+ "MD033": false, // Allow raw HTML in Markdown
+ "MD041": false // Allow multiple top-level headers in a file
+ }
+}