Updates to ecommerce-v2 [DOC-1243] #7875
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Related issues (optional)
DOC-1243