Skip to content

docs: guias em inglês e português e READMEs completos - #17

Merged
net0well merged 1 commit into
mainfrom
fase-9/documentacao
Oct 21, 2026
Merged

net0well merged 1 commit into
mainfrom
fase-9/documentacao

Conversation

@net0well

Copy link
Copy Markdown
Collaborator

Resumo

A documentação pública era só o README. Este PR cria guias por tema, com as mesmas páginas em inglês e em português, e deixa os READMEs completos e atualizados.

Guias (guides/en e guides/pt-br)

Página Conteúdo
Primeiros passos Formas de uso (somente a biblioteca, com PostgreSQL, com RabbitMQ, com o painel, hosts prontos), instalação do .NET e do uv, pacotes e a primeira Etapa
Etapas O contrato, todas as opções do stage.json, os 12 tipos nos dois lados, Etapas em C#, leitura de resultados, tipos de erro, retry e segredos
Trilhas Arquivo da trilha, ligações (explícitas e implícitas), execução, falhas e definição em C#
SDK Python @stage, contexto, arquivos, erros, testes com run_stage e a linha de comando
Persistência Configuração, migrações, catálogo versionado, execuções, idempotência, retenção e auditoria
Fila, worker e agendamento Enfileirar, caminho de uma execução, confiabilidade, concorrência, cron, eventos e o comando para outras linguagens
Painel Configuração, o que a interface faz (com prints), modos de acesso, papéis, login fixo e autenticação do host
Hospedagem Imagens, variáveis de ambiente, volumes, limites de memória, Kubernetes, Aspire e Docker Compose
Referência de configuração Todas as opções com os valores padrão
Como funciona O caminho de uma tentativa, garantias, modelo de segurança e observabilidade (spans e métricas)

Os prints do painel, em tema escuro, ficam em guides/images. Cada página tem o link para a outra língua.

READMEs

  • README principal:
    • cobre todas as capacidades com exemplos curtos: formas de uso, início rápido, contrato, trilhas, SDK, persistência, fila, painel, contêineres, observabilidade e compatibilidade;
    • cada seção termina com o link do guia que aprofunda o tema;
    • ganhou badges de CI, NuGet, PyPI e licença;
    • os links são absolutos, porque o mesmo README aparece no nuget.org.
  • README do psrunner (página do PyPI): referência completa do SDK. Ele aparece no PyPI a partir da próxima versão do psrunner.
  • CONTRIBUTING: recebe os detalhes dos projetos de teste e do painel que estavam no README.
  • CHANGELOG: nova seção Unreleased.

Verificação

  • Exemplos do nível 1 (biblioteca sem banco e sem fila): rodados com os pacotes publicados (PythonScriptRunner.Core 0.1.0 do NuGet e psrunner do PyPI). Funcionaram os três: catálogo em pasta, Etapa em C# e teste com pytest.
  • Opções, padrões, nomes de métricas, spans, eventos e routing keys: conferidos no código.
  • Links e âncoras: todos os relativos e absolutos dos guias, do README, do CONTRIBUTING e do README do psrunner resolvem para arquivos e títulos que existem.

🤖 Generated with Claude Code

A documentação pública era só o README. Agora há guias por tema, com as
mesmas páginas em inglês e em português:
- primeiros passos e formas de uso;
- Etapas, trilhas e SDK Python;
- persistência, fila e agendamento, painel;
- hospedagem, referência de configuração e como funciona.

Os prints do painel ficam em guides/images.

- README: cobre todas as capacidades com exemplos curtos e atualizados
  (formas de uso, instalação, imagens, Aspire e compatibilidade). Cada seção
  termina com o link do guia que aprofunda o tema.
- README do psrunner (a página do PyPI): vira a referência completa do SDK,
  com tipos, contexto, arquivos, erros, testes e linha de comando.
- CONTRIBUTING: recebe os detalhes dos projetos de teste e do painel que
  saíram do README.
- CHANGELOG: nova seção Unreleased.

Os exemplos do nível 1 foram conferidos com os pacotes publicados.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@net0well
net0well merged commit be3358c into main Oct 21, 2026
16 checks passed
@net0well
net0well deleted the fase-9/documentacao branch October 21, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant