Skip to content

Docs/site metodo - #13

Merged
ronifabio merged 3 commits into
mainfrom
docs/site-metodo
Sep 3, 2026
Merged

ronifabio merged 3 commits into
mainfrom
docs/site-metodo

Conversation

@ronifabio

@ronifabio ronifabio commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Closes #

O que este PR faz e por quê

Adiciona um site estático em site/, publicado no GitHub Pages, que explica o UTF-SDD para quem acabou de criar o repositório pelo Use this template. O problema que ele resolve é de porta de entrada: hoje o método está inteiro no guia-sdd.md, que passa de sessenta mil caracteres, e quem abre esse arquivo no primeiro dia não consegue enxergar a forma do ciclo antes de ler tudo. O site cobre cinco recortes — o que é o método, o ciclo com a Fase 0 e os quatro portões, os comandos, os papéis dos agentes com a trava de escrita, e os erros comuns — e em nenhum momento repete uma regra: ele explica e aponta para o .md correspondente, que continua sendo a fonte da verdade. Assim não existe risco de as duas versões divergirem no meio do semestre.

São páginas HTML escritas à mão, sem build, sem npm e sem biblioteca externa, porque este repositório é um template: não quero que o projeto do aluno herde uma toolchain de documentação que ele nunca vai usar. Pelo mesmo motivo o workflow de publicação tem a guarda if: github.repository == 'utfpr-gp/utf-sdd-template' — no repositório gerado a partir do template o job simplesmente não roda, em vez de falhar com o Pages desabilitado e deixar um X vermelho na aba Actions de quem está começando.

O conteúdo foi conferido contra o main atual: entra o /utf-design separado do /utf-flows, a Fase 0 com seis etapas, a branch criada já no /utf-issue, o portão 1 cobrindo spec e plano, o fechamento da Issue rodando /utf-issue de novo, a leitura do diff arquivo por arquivo pelo tutor, e a regra de que bug não precisa de spec.

Depois do merge é preciso trocar, em Settings → Pages, a origem para GitHub Actions. Sem isso o deploy falha.

Apontamentos da revisão

Não se aplica — PR de manutenção, sem spec.md e sem ciclo de revisão por agentes.

Aceitos:

Recusados (com o motivo):

ronifabio and others added 3 commits September 3, 2026 19:15
Cinco paginas estaticas, sem build e sem dependencia de runtime: inicio, o
ciclo, os comandos, os papeis e as duvidas. O conteudo e a explicacao do
metodo com links para docs/guia-sdd.md, docs/tutorial-sdd.md e
docs/checklist.md, que seguem sendo a fonte da verdade - o site ensina e
remete, nunca duplica regra.

O elemento estrutural e a faixa de portao: ela atravessa a pagina inteira
exatamente onde o metodo interrompe o trabalho, de modo que a leitura encena
o ciclo em vez de so descreve-lo.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
O job so roda quando github.repository e utfpr-gp/utf-sdd-template. Como o
repositorio e um template, sem essa guarda o repositorio de cada aluno
tentaria publicar o site do metodo e falharia com o Pages desabilitado.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
O link fica acima da linha de corte, na parte que o aluno apaga ao dar nome
ao projeto - e conteudo do template, nao da vitrine dele.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ronifabio
ronifabio merged commit ffcd2e5 into main Sep 3, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant