Skip to content

Commit 241dd8c

Browse files
committed
refactor: Atualizar documentação e estrutura de arquivos para melhor organização e clareza
1 parent dbc3293 commit 241dd8c

6 files changed

Lines changed: 242 additions & 373 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 76 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,106 @@
1-
# Guia de Contribuição
1+
# Guia de Contribuicao
22

3-
Obrigado por querer contribuir com o Java Labs!
3+
Obrigado por querer contribuir com o Java Labs.
44

55
## O que pode ser contribuido
66

7-
- Melhorias e correções nos conteúdos (`/notes`)
8-
- Novos exemplos de código em `/examples`
9-
- Exercícios adicionais em `/exercicios`
10-
- Projetos práticos em `/projetos`
11-
- Recursos recomendados em `/recursos`
7+
- Melhorias e correcoes nas notas em `src/content/docs/`
8+
- Novos exemplos de codigo em `examples/`
9+
- Exercicios adicionais em `examples/exercises.md`
10+
- Projetos praticos em `examples/projects.md`
11+
- Recursos recomendados em `src/content/docs/recursos.md`
12+
- Melhorias no site Astro + Starlight
1213

1314
## Processo
1415

15-
1. Crie uma branch a partir de `main` seguindo o padrão:
16-
```
16+
1. Crie uma branch a partir de `main` seguindo o padrao:
17+
18+
```text
1719
feature/descricao-curta
1820
fix/descricao-curta
1921
docs/descricao-curta
2022
```
2123

22-
2. Faça commits atômicos com mensagens no padrão de Conventional Commits:
23-
```
24-
feat: adicionar exercícios sobre loops
25-
fix: corrigir exemplo de recursão
26-
docs: melhorar conteúdo sobre herança
24+
2. Faca commits atomicos com mensagens no padrao Conventional Commits:
25+
26+
```text
27+
feat: adicionar exercicios sobre loops
28+
fix: corrigir exemplo de recursao
29+
docs: melhorar conteudo sobre heranca
2730
```
2831

29-
Tipos válidos: `feat`, `fix`, `docs`, `style`, `refactor`, `chore`
32+
Tipos validos: `feat`, `fix`, `docs`, `style`, `refactor`, `chore`
33+
34+
3. Abra um Pull Request usando o template do repositorio.
35+
36+
4. Apos aprovacao, o merge sera feito por uma pessoa mantenedora.
37+
38+
## Rodando o site localmente
39+
40+
O Java Labs usa Astro + Starlight para publicar a documentacao.
41+
42+
```bash
43+
npm install
44+
npm run dev
45+
```
46+
47+
O site fica disponivel em `http://localhost:4321`.
48+
49+
Para validar antes de abrir o PR:
50+
51+
```bash
52+
npm run build
53+
npm run preview
54+
```
55+
56+
## Padroes de conteudo
3057

31-
3. Abra um Pull Request usando o template disponível e aguarde revisão.
58+
### Notas em `src/content/docs/`
3259

33-
4. Após aprovação, o merge será feito por um mantenedor.
60+
- Escreva em portugues (pt-BR)
61+
- Use titulos hierarquicos (`##`, `###`)
62+
- Prefira exemplos curtos e objetivos
63+
- Explique o "por que" alem do "como"
64+
- Nomeie arquivos com prefixo numerico quando fizer parte da trilha, por exemplo `04-variaveis.md`
65+
- Use frontmatter Starlight completo
3466

35-
## Padrões de conteúdo
67+
Frontmatter recomendado:
3668

37-
### Documentação (Markdown)
69+
```yaml
70+
---
71+
title: "Titulo da nota"
72+
description: "Resumo curto explicando o foco da pagina."
73+
lastUpdated: 2026-01-01
74+
sidebar:
75+
order: 4
76+
tags: ["java", "tema", "iniciante"]
77+
---
78+
```
3879

39-
- Escreva em português (pt-BR)
40-
- Use títulos hierárquicos (`##`, `###`)
41-
- Prefira exemplos curtos e diretos
42-
- Inclua o "por quê", não apenas o "como"
43-
- Nomeie os arquivos com prefixo numérico sequencial: `03-nome-do-topico.md`
44-
- Atualize o índice em `notes/README.md` ao adicionar um novo tópico
80+
Se a nota ficar melhor agrupada por assunto, voce pode criar subpastas dentro de `src/content/docs/`.
4581

46-
### Exemplos de código (`/examples`)
82+
### Exemplos em `examples/`
4783

48-
- Um conceito por pasta, nomeada com prefixo sequencial: `02-NomeDoExemplo/`
49-
- Inclua um comentário no topo do arquivo explicando o que o exemplo demonstra
50-
- Adicione um `README.md` na pasta com instruções de execução
51-
- Teste o código antes de submeter: `javac Arquivo.java && java Arquivo`
84+
- Um conceito por pasta, nomeada com prefixo sequencial quando fizer sentido, por exemplo `02-Variaveis/`
85+
- Inclua um comentario no topo do arquivo explicando o objetivo do exemplo
86+
- Adicione um `README.md` na pasta com contexto e instrucoes de execucao
87+
- Teste o codigo antes de submeter com `javac Arquivo.java` e `java NomeDaClasse`
5288

53-
### Exercícios (`/exercicios`)
89+
### Exercicios em `examples/exercises.md`
5490

5591
- Descreva claramente o objetivo
56-
- Indique o nível de dificuldade (iniciante / intermediário / avançado)
57-
- Inclua exemplos de saída esperada
58-
- Use critérios de sucesso em formato de checklist
92+
- Indique o nivel de dificuldade quando necessario
93+
- Inclua exemplos de saida esperada
94+
- Use criterios de sucesso em formato de checklist
95+
- Aponte para notas relacionadas em `src/content/docs/` quando isso ajudar
5996

60-
### Projetos (`/projetos`)
97+
### Projetos em `examples/projects.md`
6198

6299
- Descreva o objetivo e o contexto
63-
- Liste os requisitos em formato de checklist
64-
- Inclua ao menos um exemplo de uso ou saída esperada
65-
- Adicione dicas para quem está começando
100+
- Liste requisitos em formato de checklist
101+
- Inclua ao menos um exemplo de uso ou saida esperada
102+
- Adicione dicas para quem esta comecando
66103

67-
## Dúvidas?
104+
## Duvidas
68105

69106
Abra uma issue com a tag `question`.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,22 @@
44

55
## Tipo de mudança
66

7-
- [ ] Novo conteúdo (`/docs`)
8-
- [ ] Novo exemplo de código (`/codigos`)
9-
- [ ] Novo exercício (`/exercicios`)
10-
- [ ] Novo projeto (`/projetos`)
11-
- [ ] Recurso recomendado (`/recursos`)
7+
- [ ] Nova anotação (`src/content/docs/`)
8+
- [ ] Novo exemplo (`examples/`)
9+
- [ ] Novo exercício (`examples/exercises.md`)
10+
- [ ] Novo projeto (`examples/projects.md`)
1211
- [ ] Correção de conteúdo existente
12+
- [ ] Melhoria no site (Astro/Starlight)
1313
- [ ] Outro: <!-- descreva -->
1414

1515
## Checklist
1616

1717
- [ ] O conteúdo está em português
1818
- [ ] Os arquivos estão no diretório correto
19+
- [ ] As notas usam frontmatter Starlight válido, quando aplicável
1920
- [ ] Exemplos de código compilam e executam sem erros
2021
- [ ] Exercícios e projetos têm objetivo e critérios de sucesso descritos
21-
- [ ] O índice (`notes/README.md`) foi atualizado, se necessário
22+
- [ ] Links e referências internas foram revisados
2223
- [ ] Minha branch está atualizada com `main`
2324
- [ ] Não há conflitos de merge
2425

.gitignore

Lines changed: 26 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,42 @@
1-
# Compiled class files
2-
*.class
1+
# Build output
2+
dist/
33

4-
# Log files
5-
*.log
4+
# Astro
5+
.astro/
66

7-
# BlueJ files
8-
*.ctxt
7+
# Dependencies
8+
node_modules/
99

10-
# Mobile Tools for Java (J2ME)
11-
.mtj.tmp/
10+
# Environment
11+
.env
12+
.env.*
13+
!.env.example
14+
15+
# OS
16+
.DS_Store
17+
Thumbs.db
18+
19+
# Editor
20+
.vscode/
21+
.idea/
22+
*.swp
23+
*.swo
1224

13-
# Package Files
25+
# Java
26+
*.class
27+
*.log
28+
*.ctxt
29+
.mtj.tmp/
1430
*.jar
1531
*.war
1632
*.nar
1733
*.ear
1834
*.zip
1935
*.tar.gz
2036
*.rar
21-
22-
# Virtual machine crash logs
2337
hs_err_pid*
2438
replay_pid*
39+
local.properties
2540

2641
# Eclipse
2742
.classpath
@@ -30,7 +45,6 @@ replay_pid*
3045
bin/
3146

3247
# IntelliJ IDEA
33-
.idea/
3448
*.iml
3549
*.iws
3650
*.ipr
@@ -40,12 +54,8 @@ out/
4054
nbproject/
4155
build/
4256
nbbuild/
43-
dist/
4457
nbdist/
4558
.nb-gradle/
46-
47-
# VS Code
48-
.vscode/
4959
*.code-workspace
5060

5161
# Maven
@@ -62,58 +72,4 @@ buildNumber.properties
6272

6373
# Gradle
6474
.gradle/
65-
build/
6675
!gradle-wrapper.jar
67-
68-
# macOS
69-
.DS_Store
70-
.AppleDouble
71-
.LSOverride
72-
73-
# Windows
74-
Thumbs.db
75-
ehthumbs.db
76-
Desktop.ini
77-
$RECYCLE.BIN/
78-
79-
# Linux
80-
*~
81-
.directory
82-
83-
# Temporary files
84-
*.tmp
85-
*.bak
86-
*.swp
87-
*~.nib
88-
local.properties
89-
90-
# Node (for any web tools)
91-
node_modules/
92-
npm-debug.log*
93-
94-
# Jekyll
95-
_site/
96-
.sass-cache/
97-
.jekyll-cache/
98-
.jekyll-metadata
99-
100-
# Build output
101-
dist/
102-
103-
# Astro
104-
.astro/
105-
106-
# Environment
107-
.env
108-
.env.*
109-
!.env.example
110-
111-
# OS
112-
.DS_Store
113-
Thumbs.db
114-
115-
# Editor
116-
.vscode/
117-
.idea/
118-
*.swp
119-
*.swo

0 commit comments

Comments
 (0)