Gabriel Felipe Souza SantosandCursor
aa75cebaaa
documentation/ fica neutra (produto); visão TP, tutorial Ping e checklists de entrega movem para docs/tp/ sem link reverso. Co-authored-by: Cursor <cursoragent@cursor.com>
31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# Documentação — Pitiupi
|
||
|
||
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 tutoriais |
|
||
| **[references/](references/README.md)** | Bibliografia e notas (UDP, TCP, SPI, multicast) |
|
||
| **[decision-register.md](decision-register.md)** | Decisões de desenho da plataforma |
|
||
|
||
## Jornadas
|
||
|
||
| Leitor | Trilha |
|
||
| --- | --- |
|
||
| **Primeiro uso** | [00_quickstart](documentation/00_quickstart.md) → [09_sistema_de_plugins](documentation/09_sistema_de_plugins.md) → [10_tutorial_plugin](documentation/10_tutorial_plugin.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) |
|
||
| **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) |
|
||
|
||
## Manutenção rápida
|
||
|
||
| Mudança | Onde documentar |
|
||
| --- | --- |
|
||
| UDP/TCP, multicast, portas | 05, 06, appendix |
|
||
| SPI / plugins | 09, 10 |
|
||
| Decisão de arquitetura | decision-register |
|
||
| Débito técnico | engineering_backlog |
|