Skip to content

docs: Standardize language, wording, and API links across all pages#697

Open
vdusek wants to merge 2 commits intomasterfrom
docs/standardize-language-and-wording
Open

docs: Standardize language, wording, and API links across all pages#697
vdusek wants to merge 2 commits intomasterfrom
docs/standardize-language-and-wording

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Apr 2, 2026

Summary

  • Standardize opening paragraphs to follow "what it is + why it matters" pattern
  • Unify example intro phrasing to "The following example shows how to..."
  • Migrate all API reference links from raw markdown to <ApiLink> component
  • Trim verbose "benefits" paragraphs in pagination and streaming pages
  • Add :::tip admonitions to convenience methods and pagination pages

🤖 Generated with Claude Code

Standardize opening paragraphs, example intro phrasing, migrate API reference
links to ApiLink component, trim verbose benefit paragraphs, and add admonitions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Apr 2, 2026
@vdusek vdusek self-assigned this Apr 2, 2026
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Apr 2, 2026
@github-actions github-actions bot added this to the 137th sprint - Tooling team milestone Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.77%. Comparing base (2f67a5d) to head (aaed9cd).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #697      +/-   ##
==========================================
- Coverage   94.79%   94.77%   -0.03%     
==========================================
  Files          45       45              
  Lines        4403     4403              
==========================================
- Hits         4174     4173       -1     
- Misses        229      230       +1     
Flag Coverage Δ
integration 94.77% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek requested a review from Pijukatel April 2, 2026 14:47
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants