Skip to content

Conversation

rchinn1
Copy link
Contributor

@rchinn1 rchinn1 commented Sep 3, 2025

This pull request makes several documentation improvements to the src/connections/spec/ecommerce/v2.md file for the V2 Ecommerce Events spec. The main focus is on standardizing table formatting, clarifying language, and improving consistency across event descriptions and property definitions.

Documentation formatting and consistency:

  • Standardized all table headers by removing bold formatting and ensuring uniform column names (e.g., Action, Description, Property, Type) throughout the document. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]

  • Improved property descriptions for clarity and consistency, such as updating "Database id" to "Database ID" for product identifiers. [1] [2]

Content and language clarity:

  • Removed unnecessary note formatting by replacing > info "Note" with > info "" to standardize callout sections and avoid confusion. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

  • Fixed minor typos and improved language for better readability, such as removing unnecessary articles in descriptions (e.g., "User viewed product details" instead of "User viewed a product details").

These changes collectively enhance the readability and maintainability of the documentation, making it easier for users to understand and implement the e-commerce event spec.

Proposed changes

Merge timing

  • Once approved

Related issues (optional)

DOC-1243

@rchinn1 rchinn1 added the content-update updates to content that are not new features, includes grammar fixes, added notes label Sep 3, 2025
Copy link

netlify bot commented Sep 3, 2025

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 6269aa6
🔍 Latest deploy log https://app.netlify.com/projects/segment-docs/deploys/68b8c20516375f0008a873a2
😎 Deploy Preview https://deploy-preview-7875--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rchinn1 rchinn1 marked this pull request as ready for review September 4, 2025 22:32
@rchinn1 rchinn1 requested a review from a team as a code owner September 4, 2025 22:32
@rchinn1 rchinn1 requested a review from sade-wusi September 4, 2025 22:32
@rchinn1 rchinn1 merged commit 16c3f22 into develop Sep 5, 2025
4 checks passed
@rchinn1 rchinn1 deleted the ecommerce-v2-audit branch September 5, 2025 15:52
Copy link
Contributor

github-actions bot commented Sep 5, 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