Skip to content

Doc-12350: technical writing review - #1956

Merged
gcatanese merged 5 commits into
Adyen:mainfrom
martingleissner:DOC-12350-doc-review
May 13, 2026
Merged

Doc-12350: technical writing review#1956
gcatanese merged 5 commits into
Adyen:mainfrom
martingleissner:DOC-12350-doc-review

Conversation

@martingleissner

Copy link
Copy Markdown
Contributor

Changes

  • Fixed US spelling (Licence → License)
  • Replaced Latin abbreviations (e.g., i.e.) with plain English
  • Removed modal verb "should" where appropriate
  • Fixed contractions (shouldn't → Do not)
  • Minor grammar and word order fixes

Questions

I've added comments on specific lines where I have questions for the team.

@martingleissner
martingleissner requested a review from a team as a code owner May 13, 2026 08:31

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request focuses on refining the documentation in README.md and doc/MigratingToCloudDeviceApi.md. Key changes include standardizing terminology (such as replacing 'e.g.' and 'i.e.' with 'for example'), correcting spelling, and making instructions more direct. Review feedback suggests further improving consistency by simplifying the Java version requirement and removing redundant phrasing in the timeout configuration section.

Comment thread README.md Outdated
Comment thread README.md Outdated

@martingleissner martingleissner left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Additional questions and comments

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread doc/MigratingToCloudDeviceApi.md
gcatanese and others added 3 commits May 13, 2026 11:01
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

@gcatanese gcatanese left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you Martin for your contribution!
I have addressed most of your feedback, and created new issues for aspects that require further attention.

@gcatanese
gcatanese added this pull request to the merge queue May 13, 2026
Merged via the queue into Adyen:main with commit 2a005cd May 13, 2026
5 checks passed
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.

2 participants