Skip to content

docs: fix grammar typos in client-initiated-sequence, components-roles, future-directions#86

Open
alelpoan wants to merge 3 commits into
agentcommercekit:mainfrom
alelpoan:fix/docs-typos-and-inaccuracies
Open

docs: fix grammar typos in client-initiated-sequence, components-roles, future-directions#86
alelpoan wants to merge 3 commits into
agentcommercekit:mainfrom
alelpoan:fix/docs-typos-and-inaccuracies

Conversation

@alelpoan
Copy link
Copy Markdown

@alelpoan alelpoan commented May 14, 2026

Grammar fixes with explanations

This PR corrects three minor grammar issues in the documentation:

1. client-initiated-sequence.mdx

  • Before: … or or other dynamic interactions …
  • After: … or other dynamic interactions …

Duplicate or is redundant and grammatically incorrect.

2. components-roles.mdx

  • Before: … a sophisticated flow involved a Payment Service.
  • After: … a sophisticated flow involving a Payment Service.

After the noun flow, the present participle involving is needed (not past tense involved).

3. future-directions.mdx

  • Before: … ACK begins to addresses critical gaps …
  • After: … ACK begins to address critical gaps …

The infinitive form address is required after begins to (not third-person singular addresses).

Summary by CodeRabbit

  • Documentation
    • Clarified "Approvals and HITL" steps in the client-initiated payment service sequence documentation.
    • Refined wording in Payment Service component diagram descriptions for better clarity.
    • Corrected grammar and improved readability across payment service and overview documentation.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4656ede5-885a-4783-a174-83125da9b014

📥 Commits

Reviewing files that changed from the base of the PR and between 6f65936 and fc5557b.

📒 Files selected for processing (3)
  • docs/ack-pay/client-initiated-sequence.mdx
  • docs/ack-pay/components-roles.mdx
  • docs/overview/future-directions.mdx

Walkthrough

This PR contains three minor documentation corrections across the ACK-Pay and overview sections. The changes fix grammatical errors (duplicated "or", incorrect verb conjugation), clarify diagram descriptions, and improve overall documentation accuracy without altering substantive content or functionality.

Changes

Documentation Updates

Layer / File(s) Summary
Grammar and clarity corrections
docs/ack-pay/client-initiated-sequence.mdx, docs/ack-pay/components-roles.mdx, docs/overview/future-directions.mdx
Client-initiated sequence step removes "or or" duplication, diagram introductory text is rephrased from "flow involving" to "component activity," and verb conjugation is corrected from "begins to addresses" to "begins to address."

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the pull request's main purpose: fixing grammar typos across three specific documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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