Gabriel Felipe Souza SantosandCursor
8fe9bee453
LocalNetworkInfo prefere cabo antes de Wi-Fi e 169.254.x na interface; documenta escolha de interface no apendice de multicast. Co-authored-by: Cursor <cursoragent@cursor.com>
Documentação — Pitiupi
Entrada na raiz do repositório: README.md.
Pilares
| Pasta / arquivo | Papel |
|---|---|
| documentation/ | Código, rede, plugins, operação e guia para alunos |
| references/ | Bibliografia e notas de conceitos (UDP, TCP, SPI) |
| decision-register.md | Decisões de desenho da plataforma |
Público-alvo
| Leitor | Começar por |
|---|---|
| Aluno (TP) | documentation/00_quickstart.md → 10_tutorial_plugin.md → 11_plugins_referencia.md |
| Monitor / docência | documentation/01_visao_disciplina_e_tp.md → 15_testes_e_gate.md |
| Desenvolvedor | documentation/13_guia_dev_e_agente.md → 14_arquitetura_e_manutencao.md |
| Professor / banca | documentation/16_fundamentacao_redes.md → references/README.md |
Idioma: documentação em PT-BR; pacotes e classes Java como no código.
Manutenção
| Tipo de mudança | Onde documentar |
|---|---|
| Protocolo UDP/TCP, multicast, portas | documentation/05_udp_multicast.md, 06_tcp_conexoes.md, appendix_portas_e_multicast.md |
| Contrato de plugin / SPI | documentation/09_sistema_de_plugins.md, 10_tutorial_plugin.md |
| Novo plugin de referência | documentation/11_plugins_referencia.md |
| Decisão de arquitetura | decision-register.md |
| Débito técnico | documentation/engineering_backlog.md |
| Literatura de redes | references/ |
Documentação legada em pitiupi/docs/ redireciona para esta árvore.