Skip to content

Conversation

rchinn1
Copy link
Contributor

@rchinn1 rchinn1 commented Sep 5, 2025

This pull request makes a series of editorial and clarity improvements to the documentation, focusing on consistency, grammar, and readability. The changes include standardizing terminology, improving parallel structure, and clarifying descriptions across several documentation files.

Documentation and editorial improvements:

  • Standardized terminology and improved parallel structure in lists and descriptions, such as changing "and" to "and/or" where appropriate, and making list punctuation consistent in src/privacy/data-retention-policy.md. [1] [2]
  • Improved grammar, punctuation, and word choice for clarity and readability throughout src/connections/sources/catalog/libraries/mobile/apple/index.md, including section titles, option names, and warning/info boxes. [1] [2] [3] [4] [5] [6]
  • Updated table headers and property descriptions for consistency in src/connections/spec/screen.md.
  • Refined explanations and recommendations to ensure best practices are clearly communicated, such as setting device IDs and sending complete object data. [1] [2]
  • Made section and heading capitalization consistent, such as "Effective date" and other section headers in src/privacy/data-retention-policy.md.

These changes help ensure the documentation is more professional, accurate, and user-friendly.

Proposed changes

Merge timing

Related issues (optional)

@rchinn1 rchinn1 added the content-update updates to content that are not new features, includes grammar fixes, added notes label Sep 5, 2025
@rchinn1 rchinn1 marked this pull request as ready for review September 8, 2025 15:23
@rchinn1 rchinn1 requested a review from a team as a code owner September 8, 2025 15:23
@rchinn1 rchinn1 merged commit 2e50e39 into develop Sep 8, 2025
4 checks passed
@rchinn1 rchinn1 deleted the data-retention-policy branch September 8, 2025 17:04
Copy link
Contributor

github-actions bot commented Sep 8, 2025

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content-update updates to content that are not new features, includes grammar fixes, added notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants