Skip to content

Conversation

rchinn1
Copy link
Contributor

@rchinn1 rchinn1 commented Aug 29, 2025

This pull request makes several improvements to the documentation for the Segment Public API, focusing on clarity, accuracy, and inclusivity of SDK support. The changes enhance readability, update terminology, and clarify instructions for users.

Documentation clarity and accuracy:

  • Clarified the CRUD acronym in the introduction to explicitly include "update" and improved the description for better readability.
  • Updated instructions for creating a Public API token to use consistent bold formatting for roles and UI elements, and clarified the process steps.
  • Improved the explanation for including the Public API token in HTTP requests, making it clearer and more concise.
  • Changed section titles and references to use consistent capitalization and terminology (e.g., "API token security").

SDK and user guidance updates:

  • Added C# to the list of supported languages for Segment's Public API SDKs and corrected the spelling of "JavaScript."

General improvements:

  • Improved phrasing for recommendations and FAQ answers to use more inclusive language (e.g., "We recommend...").
  • Updated role references and troubleshooting instructions for clarity and accuracy, including links and error explanations.

Proposed changes

Merge timing

  • Once approved

Related issues (optional)

DOC-1232

@rchinn1 rchinn1 added the content-update updates to content that are not new features, includes grammar fixes, added notes label Aug 29, 2025
@rchinn1 rchinn1 requested a review from a team as a code owner August 29, 2025 20:43
@rchinn1 rchinn1 requested a review from forstisabella August 29, 2025 20:43
@rchinn1 rchinn1 merged commit c1306f4 into develop Sep 2, 2025
4 checks passed
@rchinn1 rchinn1 deleted the Public-API-updates branch September 2, 2025 19:25
Copy link
Contributor

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