Skip to content

Conversation

rchinn1
Copy link
Contributor

@rchinn1 rchinn1 commented Sep 9, 2025

This pull request makes several improvements to the documentation in src/getting-started/06-testing-debugging.md, focusing on clarity, consistency, and accuracy. The changes primarily standardize terminology (e.g., "Source" vs. "source"), improve grammar and punctuation, and clarify instructions for using the Event Delivery tool.

Documentation consistency and clarity:

  • Standardized the capitalization of "source" throughout the document for consistency and updated related references in descriptions of the Debugger and Event Delivery tool. [1] [2]
  • Improved grammar and punctuation in explanations and instructions, such as clarifying how to select a time period and updating bullet point formatting for key metrics and error details. [1] [2]
  • Enhanced the description of the Error Details view by consolidating bullet points, adding missing information about the "Response from Destination," and refining links to related documentation.

Formatting and style:

  • Removed unnecessary blank lines and adjusted section headings for better readability.
  • Updated phrasing for better readability, such as rewording when Event Delivery is most useful and how to pause the Debugger stream. [1] [2]

Proposed changes

Merge timing

Related issues (optional)

DOC-1263

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

netlify bot commented Sep 9, 2025

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 69fe19f
🔍 Latest deploy log https://app.netlify.com/projects/segment-docs/deploys/68c0569dfff6f20007c04702
😎 Deploy Preview https://deploy-preview-7921--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 9, 2025 17:01
@rchinn1 rchinn1 requested a review from a team as a code owner September 9, 2025 17:01
Co-authored-by: forstisabella <92472883+forstisabella@users.noreply.github.com>
@rchinn1 rchinn1 merged commit 2c846b0 into develop Sep 9, 2025
4 checks passed
@rchinn1 rchinn1 deleted the testing-and-debugging branch September 9, 2025 18:46
Copy link
Contributor

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