Gabriel Felipe Souza SantosandCursor
de65f3063f
Índices por jornada, convenções, diagramas Mermaid, correções de arquitetura (MainShellFrame, TCP/PluginManager), tutoriais com verificações e troubleshooting; remove redirect pitiupi/docs. Co-authored-by: Cursor <cursoragent@cursor.com>
2.1 KiB
2.1 KiB
Guia para desenvolvimento
Esta documentação descreve a ferramenta Pitiupi neste repositório: build, rede, plugins e convenções de código.
Leitura mínima antes de mudar código
- 00_quickstart.md — build e execução
- 04_inicializacao_e_gui.md — boot e diagrama
- 09_sistema_de_plugins.md — contrato de extensão
- 14_arquitetura_e_manutencao.md — mapa de pacotes
Por tipo de tarefa
| Tarefa | Ler primeiro |
|---|---|
| Novo plugin (aluno) | 10_tutorial_plugin.md, 11_plugins_referencia.md |
| Bug UDP / multicast | 05_udp_multicast.md, appendix_portas_e_multicast.md |
| Bug TCP / conexão | 06_tcp_conexoes.md |
| Presença / lista de usuários | 08_heartbeat_e_presenca.md |
| Desserialização / mensagens | 07_mensagens_e_serializacao.md |
Gate de build
cd pitiupi && ant jar && ant test
cd plugins/chat && ant jar
cd plugins/screencast && ant jar
Ou na raiz: ./scripts/pitiupi.sh build --all.
Testes manuais em rede: 15_testes_e_gate.md.
Documentação viva
Ao alterar comportamento visível ou protocolo:
| Mudou | Atualizar |
|---|---|
| Boot, shell, abas | 04, 14 |
| UDP/multicast/portas | 05, appendix |
| TCP/framing | 06 |
| Mensagens/despacho | 07 |
| Heartbeat/presença | 08, decision-register se constante |
| SPI / API plugin | 09, 10 |
| Plugin de referência | 11 |
Convenções de escrita: 00_convencoes.md.
Convenções
- Código e identificadores em inglês (pacotes
pitiupi.*). - Documentação em português (BR) em
docs/. - Evitar alterar o núcleo para um único plugin — preferir extensão via
PluginePluginWorkspace.