docs: fix style guide audit findings#750
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8442499dca
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| C->>S: WebSocket connect | ||
| C->>S: authorization (Credential) | ||
| S->>C: payment-receipt | ||
| S->>C: payment-Receipt |
There was a problem hiding this comment.
Use the actual WebSocket receipt discriminator
In the WebSocket transport docs, the protocol table and example messages above still define the discriminator as payment-receipt, but this diagram now renders payment-Receipt (and the color key was changed the same way). Readers implementing the flow from the sequence diagram would send or listen for a discriminator that doesn't match the documented message protocol, so keep the diagram label lower-case.
Useful? React with 👍 / 👎.
Summary
Motivation
Keep the documentation aligned with the current style guide and remove a rule that no longer matches accepted docs patterns.
Key design considerations
escrowonly where it documents an actual code identifier