README como página inicial pública - #4
Merged
Merged
Conversation
O README era de mantenedor, não landing page: nenhuma linha de código, num projeto que existe para ser usado em uma linha. Quem chega do npm ou da busca não via o que a lib faz. Os irmãos já abertos (bncc-dados, bncc-benchmark) seguem outro padrão, replicado aqui: badges, um parágrafo com o número âncora (1.721 aprendizagens), "Uso rápido" com código executável no topo, "Quem mantém" e mapa do ecossistema. Corrige também uma contradição factual que sobrou da auditoria: o texto ainda dizia "Pré-releases 0.1.x publicadas" enquanto a tabela já dizia 0.3.1 e 0.2.0. Sai o jargão interno "(Fase 2)" da primeira frase, a tabela passa a ser indexada pelo nome do pacote publicado (com link para npm e PyPI) em vez do caminho da pasta, e entram o snippet de config do MCP e o bloco de desenvolvimento. Todos os exemplos foram executados antes de entrar: porCodigo, habilidadesEF (37), buscar (6), decodificar nos dois ecossistemas, e as 7 tools conferidas contra packages/mcp/src/tools.ts. Links internos verificados; sem travessão, conforme a convenção de copy pública do projeto.
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
1 participant
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.
Revisão do README pensando em quem chega no repositório depois do flip.
O diagnóstico
Era um README de mantenedor: nenhuma linha de código, num projeto cujo pitch é "consumível em uma linha". Os dois irmãos já abertos seguem outro padrão, e este ficou fora dele.
Achados corrigidos
0.1.xpublicadas" vs. tabela com0.3.1/0.2.0packages/bncc)mcpServers+ o endpoint hospedadoVerificação
porCodigo('EF67LP08')(texto, prática "Leitura", localizador do PDF),habilidadesEF→ 37,buscar→ 6,decodificarnos dois ecossistemas. As 7 tools conferidas contrapackages/mcp/src/tools.ts.