docs: adicionar screenshots reais ao README (PT/EN) - #16
Merged
Conversation
Fecha a lacuna apontada antes de publicar o projeto: nenhuma imagem no README, que é o item de maior impacto na primeira impressao de quem visita o repositorio. 6 capturas de tela reais da aplicacao rodando (nao mockups), reduzidas de 1920px pra 1400px de largura e com paleta de 200 cores - ~412KB no total, sem perda visivel de nitidez em texto/UI: - Captura Rapida (voz, logs, imagens) - Incidentes (lifecycle aberto/reconhecido/resolvido) - Knowledge Base (listagem) - Artigo de KB (gerado a partir de um incidente) - Busca Inteligente - Post-Mortem (templates Google SRE/Netflix/AWS) Secao "Screenshots" adicionada logo apos os badges, antes do indice - primeira coisa que aparece ao abrir o README.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a “Screenshots” section to both the Portuguese and English READMEs to showcase real UI captures, improving the project’s first-impression documentation for potential users/contributors.
Changes:
- Added a new “Screenshots” section with a 2×3 image grid (HTML table) in
README.mdandREADME.en.md. - Linked the new section from each README’s table of contents.
- Referenced six screenshot assets under
docs/screenshots/*.png.
Reviewed changes
Copilot reviewed 2 out of 8 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds a screenshots gallery section (PT) and TOC entry pointing to it. |
| README.en.md | Adds the same screenshots gallery section (EN) and corresponding TOC entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 fecha
O último item pendente da lista de melhorias antes de publicar: nenhuma imagem no README. Um projeto de UI sem screenshot perde a maioria dos visitantes em segundos — era o item de maior impacto e menor esforço, mas dependia de rodar a aplicação de verdade (o sandbox onde venho trabalhando não alcança o Mongo), então ficou esperando você me enviar as capturas.
O que mudou
6 screenshots reais da aplicação rodando (não mockups) — inclusive mostrando dados dos incidentes/KBs que semeei via
seed-sample-data.js:Reduzi de 1920px para 1400px de largura e quantizei pra 200 cores antes de comitar — ~412KB no total pras 6 imagens (média de ~65KB cada), sem perda visível de nitidez em texto/UI. Seção adicionada logo após os badges, antes do índice, nos dois READMEs (PT/EN).
Test plan