refactor(skills): cut the workflows to ~100 lines and scale phases by tier

Each workflow was ~300 lines of grep-count "VERIFICAR" steps and ran every phase for every request. Phases now state their minimum tier, checks are the quality gate plus real tools, detail moved to references/, and machine-specific paths and non-public skills are gone. Security references move to OWASP Top 10:2025, ASVS 5.0 and the OWASP LLM Top 10. Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-09-24 21:52:06 -03:00
1 parent c18d3356ae
commit f2db2d69da
@@ -0,0 +1,30 @@
+# Estrutura do README por tipo
+
+Ordem base. Corte a seção que não se aplica em vez de preencher com texto genérico.
+
+| Seção | Fonte no repo | Obrigatória para |
+|---|---|---|
+| Título e uma linha de descrição | `name`/`description` do manifest | todos |
+| Badges | `LICENSE`, `.github/workflows/`, registro do pacote | só o que existe |
+| O que faz | entrypoints, exports, rotas | todos |
+| Pré-requisitos | `engines`, `requires-python`, `go` no `go.mod`, Dockerfile | todos |
+| Quick start | scripts do manifest, `Makefile` | todos |
+| Uso | saída real do `--help`, exemplos que rodam | CLI, biblioteca |
+| API | exports públicos, OpenAPI | biblioteca, API |
+| Configuração | `.env.example`, arquivo de config | quem tem env vars |
+| Estrutura do projeto | árvore real (`git ls-files`) | monorepo, app |
+| Contribuição | `CONTRIBUTING.md`, comandos de teste e lint | open source |
+| Licença | `LICENSE` | todos |
+
+## Por tipo
+
+- **Biblioteca**: instalação pelo gerenciador, um exemplo mínimo que roda, link para a API.
+- **CLI**: instalação, `--help` real, dois ou três comandos comuns com a saída.
+- **Web app**: pré-requisitos, `.env`, como subir em dev, como rodar os testes.
+- **API**: como subir, onde está o OpenAPI, autenticação, um `curl` que funciona.
+- **Monorepo**: tabela de pacotes com uma linha cada e o comando para rodar todos.
+
+## Quick start
+
+Copiável de ponta a ponta: clonar, instalar, configurar, rodar, ver o primeiro resultado.
+Dependência opcional fica fora do caminho principal, numa seção à parte.
@@ -0,0 +1,25 @@
+# Comandos de verificação do README
+
+Rode da raiz do repositório.
+
+```bash
+# Links locais que não existem no disco
+grep -oE '\]\([^)#]+' README.md | sed 's/^](//' | grep -vE '^(https?:|mailto:)' \
+  | while read -r p; do [ -e "$p" ] || echo "FALTA: $p"; done
+
+# Links externos que não respondem 2xx/3xx
+grep -oE 'https?://[^) >"]+' README.md | sort -u | while read -r u; do
+  c=$(curl -sIL -o /dev/null -w '%{http_code}' --max-time 10 "$u")
+  case "$c" in 2*|3*) ;; *) echo "$c $u";; esac
+done
+
+# TODO esquecido
+grep -n 'TODO' README.md
+
+# Quick start num clone limpo (troque pelos comandos do README)
+tmp=$(mktemp -d) && git clone -q . "$tmp/repo" && cd "$tmp/repo"
+# ... cole aqui os comandos de instalação e quick start, na ordem do README
+```
+
+Para CLI, compare a seção de uso com `<cli> --help`. Para API, rode o `curl` do README contra o
+servidor local e confira o status. Anote no relatório cada comando e o resultado.