Skip to content

Conversation

rchinn1
Copy link
Contributor

@rchinn1 rchinn1 commented Aug 28, 2025

This pull request makes a number of editorial and clarity improvements to the src/connections/spec/common.md documentation. The main focus is on improving grammar, consistency, formatting, and the precision of language, as well as updating links and code references for clarity.

Documentation improvements:

  • Improved grammar, punctuation, and clarity throughout the document, including more consistent capitalization of terms (e.g., "Identify call", "Analytics.js", "Track event") and improved explanation of context fields. [1] [2] [3]
  • Updated and clarified table entries for context fields, including better descriptions, capitalization, and formatting of example values and notes.
  • Enhanced timestamp section with improved explanations, punctuation, and formatting, including clarifying the calculation and recommended usage of each timestamp field. [1] [2]
  • Refined FAQ section with more readable headings, improved explanations, and updated internal documentation links to use relative paths where appropriate.

Proposed changes

Merge timing

Related issues (optional)

Related to Doc-1229

@rchinn1 rchinn1 requested a review from a team as a code owner August 28, 2025 16:27
@rchinn1 rchinn1 added the content-update updates to content that are not new features, includes grammar fixes, added notes label Aug 28, 2025
@rchinn1 rchinn1 requested a review from pwseg August 28, 2025 16:27
@pwseg
Copy link
Contributor

pwseg commented Aug 28, 2025

@rchinn1 Awesome job on this!

@rchinn1 rchinn1 merged commit b15002a into develop Aug 28, 2025
4 checks passed
@rchinn1 rchinn1 deleted the Common-Fields branch August 28, 2025 18:49
Copy link
Contributor

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