docs: refinamento integral da documentação didática
Í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>
This commit is contained in:
1 parent
7460465f81
commit
de65f3063f
18 files changed
+383
-126
No files matched your search
+17
-21
@@ -1,35 +1,31 @@
|
||||
# Documentação — Pitiupi
|
||||
|
||||
Entrada na raiz do repositório: [README.md](../README.md).
|
||||
Entrada no repositório: [README.md](../README.md) (quickstart e comandos).
|
||||
|
||||
Convenções editoriais: [documentation/00_convencoes.md](documentation/00_convencoes.md).
|
||||
|
||||
## Pilares
|
||||
|
||||
| Pasta / arquivo | Papel |
|
||||
| --- | --- |
|
||||
| **[documentation/](documentation/README.md)** | Código, rede, plugins, operação e guia para alunos |
|
||||
| **[references/](references/README.md)** | Bibliografia e notas de conceitos (UDP, TCP, SPI) |
|
||||
| **[documentation/](documentation/README.md)** | Código, rede, plugins, operação e tutoriais |
|
||||
| **[references/](references/README.md)** | Bibliografia e notas (UDP, TCP, SPI, multicast) |
|
||||
| **[decision-register.md](decision-register.md)** | Decisões de desenho da plataforma |
|
||||
|
||||
## Público-alvo
|
||||
## Jornadas
|
||||
|
||||
| Leitor | Começar por |
|
||||
| Leitor | Trilha |
|
||||
| --- | --- |
|
||||
| **Aluno (TP)** | [documentation/00_quickstart.md](documentation/00_quickstart.md) → [10_tutorial_plugin.md](documentation/10_tutorial_plugin.md) → [17_tutorial_ping_aula.md](documentation/17_tutorial_ping_aula.md) → [11_plugins_referencia.md](documentation/11_plugins_referencia.md) |
|
||||
| **Monitor / docência** | [documentation/01_visao_disciplina_e_tp.md](documentation/01_visao_disciplina_e_tp.md) → [15_testes_e_gate.md](documentation/15_testes_e_gate.md) |
|
||||
| **Desenvolvedor** | [documentation/13_guia_desenvolvimento.md](documentation/13_guia_desenvolvimento.md) → [14_arquitetura_e_manutencao.md](documentation/14_arquitetura_e_manutencao.md) |
|
||||
| **Professor / banca** | [documentation/16_fundamentacao_redes.md](documentation/16_fundamentacao_redes.md) → [references/README.md](references/README.md) |
|
||||
| **Aluno (TP)** | [00_quickstart](documentation/00_quickstart.md) → [09_sistema_de_plugins](documentation/09_sistema_de_plugins.md) → [10_tutorial_plugin](documentation/10_tutorial_plugin.md) → [17_tutorial_ping_aula](documentation/17_tutorial_ping_aula.md) → [11_plugins_referencia](documentation/11_plugins_referencia.md) |
|
||||
| **Redes (conceito + código)** | [16_fundamentacao_redes](documentation/16_fundamentacao_redes.md) → [05](documentation/05_udp_multicast.md)–[08](documentation/08_heartbeat_e_presenca.md) → [appendix_portas_e_multicast](documentation/appendix_portas_e_multicast.md) |
|
||||
| **Monitor / docência** | [01_visao_disciplina_e_tp](documentation/01_visao_disciplina_e_tp.md) → [15_testes_e_gate](documentation/15_testes_e_gate.md) |
|
||||
| **Desenvolvedor núcleo** | [13_guia_desenvolvimento](documentation/13_guia_desenvolvimento.md) → [14_arquitetura_e_manutencao](documentation/14_arquitetura_e_manutencao.md) → [04_inicializacao_e_gui](documentation/04_inicializacao_e_gui.md) |
|
||||
|
||||
**Idioma:** documentação em PT-BR; pacotes e classes Java como no código.
|
||||
## Manutenção rápida
|
||||
|
||||
## Manutenção
|
||||
|
||||
| Tipo de mudança | Onde documentar |
|
||||
| Mudança | Onde documentar |
|
||||
| --- | --- |
|
||||
| Protocolo UDP/TCP, multicast, portas | [documentation/05_udp_multicast.md](documentation/05_udp_multicast.md), [06_tcp_conexoes.md](documentation/06_tcp_conexoes.md), [appendix_portas_e_multicast.md](documentation/appendix_portas_e_multicast.md) |
|
||||
| Contrato de plugin / SPI | [documentation/09_sistema_de_plugins.md](documentation/09_sistema_de_plugins.md), [10_tutorial_plugin.md](documentation/10_tutorial_plugin.md) |
|
||||
| Novo plugin de referência | [documentation/11_plugins_referencia.md](documentation/11_plugins_referencia.md) |
|
||||
| Decisão de arquitetura | [decision-register.md](decision-register.md) |
|
||||
| Débito técnico | [documentation/engineering_backlog.md](documentation/engineering_backlog.md) |
|
||||
| Literatura de redes | [references/](references/) |
|
||||
|
||||
Documentação legada em `pitiupi/docs/` redireciona para esta árvore.
|
||||
| UDP/TCP, multicast, portas | 05, 06, appendix |
|
||||
| SPI / plugins | 09, 10 |
|
||||
| Decisão de arquitetura | decision-register |
|
||||
| Débito técnico | engineering_backlog |
|
||||
Reference in new issue
Block a user