Skip to content

docs: fix style guide audit findings#750

Merged
brendanjryan merged 1 commit into
mainfrom
brendanjryan/docs-style-guide-audit-fixes
Jun 24, 2026
Merged

docs: fix style guide audit findings#750
brendanjryan merged 1 commit into
mainfrom
brendanjryan/docs-style-guide-audit-fixes

Conversation

@brendanjryan

Copy link
Copy Markdown
Collaborator

Summary

  • Remove the variant code-group restriction from the docs agent guidance
  • Normalize MPP terminology capitalization for Challenge, Credential, and Receipt across docs prose
  • Fix multi-line highlight markers, skipped heading levels, and reserved-funds/specification wording

Motivation

Keep the documentation aligned with the current style guide and remove a rule that no longer matches accepted docs patterns.

Key design considerations

  • Preserve code identifiers and parameter names while updating surrounding prose
  • Keep escrow only where it documents an actual code identifier
  • Use singular IETF Specification wording consistently

@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mpp Ready Ready Preview, Comment Jun 24, 2026 11:16pm

Request Review

@brendanjryan brendanjryan marked this pull request as ready for review June 24, 2026 23:17
@brendanjryan brendanjryan merged commit f0c9e29 into main Jun 24, 2026
11 checks passed
@brendanjryan brendanjryan deleted the brendanjryan/docs-style-guide-audit-fixes branch June 24, 2026 23:17

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant