Skip to content

PHPAY-171: doc: show the first charge as a GIF in the quickstart - #172

Merged
mariolucasdev merged 1 commit into
developfrom
doc/phpay-171
Oct 26, 2026
Merged

mariolucasdev merged 1 commit into
developfrom
doc/phpay-171

Conversation

@mariolucasdev

Copy link
Copy Markdown
Collaborator

Closes #171

O README contava o fluxo em código, mas a página não mostrava o que acontece.
O GIF entra na seção Início rápido, logo antes do bloco que já estava lá.

O que ele mostra

composer require → a cadeia da cobrança sendo escrita → as três requisições
que saíram
, com o CPF já sem pontuação e o valor em reais, que é a unidade do
Asaas.

O código do GIF roda

Não é encenação. O arquivo foi executado com a rede falseada
(ClientFactory::fake()) antes de virar quadro, e as requisições na tela são as
que ClientFactory::recorded() devolveu, nessa ordem:

1 POST /v3/customers — {"name":"Maria Oliveira","cpfCnpj":"12345678909",…}
2 POST /v3/payments — {"billingType":"PIX",…,"value":149.9}
3 GET /v3/payments/pay_8kz2m1/pixQrCode

As duas linhas que o GIF comenta em cima disso — o CPF perdendo a pontuação no
Customer::make() e o Money::reais('149,90') virando 149.9 porque o Asaas é
de reais — são leitura desses dois corpos, não afirmação solta.

Por que versionado, e não em user-attachments

A capa de hoje vive em user-attachments, que só se consegue arrastando o
arquivo no navegador — não há como fazer isso dentro de um PR. São 569 KB, com
paleta de 128 cores e sem dithering, que é o que mantém o texto limpo num GIF.

Identidade

Roxo #6565FE, roxo claro #7C7CFF e rosa #FF49AE, amostrados da própria capa
do README; wordmark phpay na barra da janela e no cartão de abertura.

Fora de escopo

Só o README do core. O bridge ganha o dele num PR próprio.

The quickstart tells the flow in code, but the page never shows what
happens: three requests leave a single chain, the document loses its
punctuation on the way, and the amount goes out in the unit that gateway
expects.

The recording is the code that runs, not a mock-up — it was executed
against the faked network first, and the requests on screen are the ones
that actually left.

The file is committed under docs/img/ on purpose: the existing cover
lives in user-attachments, which is reachable only from the browser and
cannot travel in a pull request.
@mariolucasdev
mariolucasdev merged commit e1c994a into develop Oct 26, 2026
8 checks passed
@mariolucasdev
mariolucasdev deleted the doc/phpay-171 branch October 26, 2026 20:52
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.

doc: mostrar a primeira cobrança no README, em movimento

1 participant