docs: um passeio guiado pela arquitetura, e o mapa vira diagrama - #12
Merged
Conversation
Faltava um documento que respondesse **"como isso funciona?"** para quem nunca viu o projeto. O `docs/` explica como instalar cada frente e o `contrato-mqtt.md` explica o formato das mensagens, mas nenhum dos dois conta a historia de ponta a ponta. `COMO-FUNCIONA.md` conta, em quinze minutos e com diagramas Mermaid: - as duas jornadas que definem o repositorio: a de ida (dedo no botao ate o motor girar, em oito passos) e a de volta (posicao do GPS ate o grafico no celular, em sete); - os cinco servicos do Pi numa tabela: o que cada um assina, o que publica, o que faz; - as tres camadas de `motores/`, e por que as duas de baixo rodam sem robo; - o barramento MQTT inteiro numa tabela, com quem publica e quem consome — inclusive os dois topicos que ainda nao tem consumidor; - as tres camadas independentes de seguranca de movimento, e por que sao tres: cada uma cobre a falha da anterior; - as duas armadilhas que ja custaram caro (dois brokers na 1883, e os servicos nao instalados no robo). **E o `MAPA-COMUNICACAO.md` ganhou um diagrama de verdade.** O ASCII de 30 linhas era legivel no editor e nao dizia quem falava com quem sem esforco; virou Mermaid, que o GitHub renderiza — com duas ressalvas escritas embaixo, porque um diagrama bonito que mostra servicos inexistentes e pior que nenhum: as setas para os servicos do `pi/services/` sao planta, nao construcao, e os topicos de voz e rota ainda nao tem quem os consuma. 135 testes continuam passando. O diagrama do mapa e os 4 do documento novo foram validados com o `mermaid-cli`, nao so escritos. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0173mr3mDsAKQuPUNaPghe9v
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que é
Faltava um documento que respondesse "como isso funciona?" para quem nunca viu o projeto. O
docs/explica como instalar cada frente e ocontrato-mqtt.mdexplica o formato das mensagens — mas nenhum dos dois conta a história de ponta a ponta.COMO-FUNCIONA.mdconta, em quinze minutos e com diagramas Mermaid:motores/, e por que as duas de baixo rodam sem robô;O mapa ganhou um diagrama de verdade
O ASCII de 30 linhas do
MAPA-COMUNICACAO.mdera legível no editor e não dizia quem falava com quem sem esforço. Virou Mermaid — com duas ressalvas escritas embaixo, porque um diagrama bonito que mostra serviços inexistentes é pior que nenhum:pi/services/são planta, não construção (ver a §0);Verificação
mermaid-cli🤖 Generated with Claude Code
https://claude.ai/code/session_0173mr3mDsAKQuPUNaPghe9v