release: consolida a especificacao da Sprint 1 no main - #25
Merged
Merged
Conversation
docs: remove o plugin do obsidian da documentacao do markupp
docs: glossario do dominio
docs: especificacao do sistema da Sprint 1
docs: revisao das adrs de decomposicao e painel web
feat: sonda de saude, cors e openapi alinhado ao servidor
docs: reescreve o readme
thnbi
added
documentation
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
2 participants
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 mudou
Consolidação da Sprint 1 da disciplina ISN, 66 commits.
Especificação do sistema, cobrindo as seis entregas pedidas pelo professor: requisitos,
regras de negócio, casos de uso, diagramas de blocos e fluxogramas. O resumo do projeto ficou
na abertura do README em vez de arquivo próprio. Diagrama de blocos e casos de uso em draw.io,
fluxogramas em mermaid dentro do documento.
Arquitetura. ADR-0031 registrando o painel web em Ruby on Rails como cliente da API.
ADR-0028 reescrita, posicionando a decomposição na definição pragmática de microsserviços e
nomeando o custo do banco compartilhado. ADR-0002 com o status dizendo o que foi retomado e o
que ficou em aberto.
Glossário do domínio. CONTEXT-MAP.md na raiz e markupp/CONTEXT.md com nove verbetes, que o
docs/agents/domain.md descrevia desde sempre e não existiam.
Servidor. Rota /healthz consultando o armazenamento, CORS por lista de origens vinda da
configuração, e openapi.yaml passando a documentar as seis rotas que existem, contra quatro
antes.
README reescrito: logo, badges de CI, licença e Go, descrição do projeto, como rodar, onde
está a documentação e a licença. Saíram oito seções de processo interno.
Removidos os documentos do recorte do MVP, requisitos-mvp.md e limitacoes-conhecidas.md,
que descreviam um sistema substituído pelos ADRs 0012 a 0031.
Por quê
Fecha o milestone Sprint 1, que vence em 17/09 e pede a especificação do sistema. A
documentação que existia era da época do MVP e descrevia SQLite, organização hierárquica e
ausência de autenticação, tudo revertido por ADR desde então.
O que fica de fora
O PR #24, escala a zero com KEDA, está em rascunho e não entra nesta consolidação.
Como testar
cd markupp && go test ./...Auto-review (checklist)