Skip to content

CLAUDE.md

Latest commit

 

History

History
62 lines (44 loc) · 2.82 KB

CLAUDE.md

File metadata and controls

62 lines (44 loc) · 2.82 KB
Raw

CLAUDE.md

Orientações para agentes de IA que trabalham neste repositório.

Visão geral

Repositório de conteúdo puro do Java Labs (Caramelo Tech). Contém notas em Markdown e exemplos Java executáveis - não há build de site, dependências Node ou linting.

As notas são publicadas no site do Caramelo Labs em https://caramelotech.com.br/labs/java/. Quem monta e publica o site é o repositório hub labs: a cada push em main que altere notes/ ou sidebar.json, o workflow .github/workflows/notify-hub.yml dispara o rebuild do hub via repository_dispatch.

Estrutura

notes/           # Notas em Markdown puro - cada arquivo vira uma página no site
  index.md       # Página de entrada do lab no site
  Fundamentos/   # Ambiente, introdução, sintaxe, operadores, controle de fluxo
  Java/          # Orientação a objetos, Java Core, Java moderno
  Spring/        # Spring Web, Spring Data, Spring Security
  roadmap.md     # Trilha de estudos para backend com Java
  recursos.md    # Materiais complementares
sidebar.json     # Seções da barra lateral no site (labels e ordem)
examples/        # Código Java executável com javac/java (não publicado no site)

Escrevendo notas

As notas NÃO usam frontmatter. Regras:

  • A primeira linha da nota deve ser o título como # H1 - no site, ela vira o title da página (o hub injeta o frontmatter automaticamente)
  • Use ## e ### para as demais seções (apenas um # por arquivo, na primeira linha)
  • Prefixo numérico no nome do arquivo controla a ordem na barra lateral dentro da pasta: 01-nome.md, 02-nome.md
  • Imagens ficam junto das notas (ex: notes/secao/assets/img.png), referenciadas com caminho relativo em sintaxe Markdown: ![descrição](./assets/img.png) - nunca use tags HTML <img> nem caminhos absolutos
  • Links para outras notas do site usam o caminho completo: /labs/java/<secao>/<nota>/ (slug em minúsculas, mesmo com a pasta capitalizada)

Nova seção de tema

  1. Crie a subpasta em notes/NovaSecao/ com as notas
  2. Adicione a seção em sidebar.json: 
    { "label": "Título da Seção", "directory": "NovaSecao" }

Exemplos Java

cd examples/01-HelloWorld
javac HelloWorld.java
java HelloWorld

São arquivos .java standalone, compilados direto com javac - não há Maven/Gradle.

Convenções e preferências

  • Idioma: português brasileiro (pt-BR)
  • Usar hífens (-) em vez de travessões (—) em todos os textos
  • Em Markdown, NÃO usar --- para separar seções (exceto para notas/atribuições no final do arquivo)
  • Git: Nunca fazer git commit ou git push automaticamente - apenas quando explicitamente solicitado

Recursos úteis

  • labs (hub) - estrutura do site, script de fetch e deploy