Skip to content

docs(style): apply mintlify-docs style guide to OpenAPI strings#272

Open
muhsinking wants to merge 1 commit intomainfrom
mking/style-guide-openapi
Open

docs(style): apply mintlify-docs style guide to OpenAPI strings#272
muhsinking wants to merge 1 commit intomainfrom
mking/style-guide-openapi

Conversation

@muhsinking
Copy link
Copy Markdown
Contributor

Summary

Applies the togethercomputer/mintlify-docs style guide to user-facing strings (summary, description, title) in openapi.yaml. Field names, enum values, and code samples are untouched.

Fixes by category

  • Em-dashes removed (replaced with : or rephrased): 3.
  • Future tense rewritten as present (will be addedto add, will returnreturns, will be useduses, etc.): ~30.
  • "the user" / "the user's" / "one" replaced with you / your or removed: 5.
  • "please" removed from info.description: 1.
  • Filler "just"only: 2.
  • Summary trailing periods removed: 8.
  • Case/acronym fixes: GPU ClusterGPU cluster (×2), Id/idID (×2).
  • Typo: Defined the behaviorDefines the behavior.

YAML note

Two 400/500 response descriptions had em-dashes replaced with colons. Without quoting, YAML misparses the second : as a key separator, so those two strings are now wrapped in single quotes.

Verified

  • yaml.safe_load parses the file cleanly (74 paths, 99 endpoints).
  • All 99 endpoints still have a summary field.
  • Zero remaining em-dashes, future-tense will (be|return|use|...), "please", or "the user" patterns in description/summary/title strings.

Test plan

  • Spec parses (already verified locally with yaml.safe_load).
  • Mintlify rendering of API reference looks correct on a preview build.
  • No SDK/codegen consumers break (string changes are content-only, not field-name).

🤖 Generated with Claude Code

Apply the togethercomputer/mintlify-docs style guide to summary,
description, and title fields in openapi.yaml. Fix em-dashes,
future-tense ("will be/return/use/..."), banned words ("please",
filler "just"), "the user" references, trailing periods on summaries,
and a few case/acronym issues (e.g. "GPU Cluster" -> "GPU cluster",
"Id" -> "ID"). Two error-response descriptions wrapped in single
quotes after replacing em-dashes with colons, since YAML otherwise
misparses the second colon as a key separator.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

✱ Stainless preview builds for togetherai

This PR will update the togetherai SDKs with the following commit messages.

go

docs(api): update docstrings from future to present tense

openapi

docs(api): update descriptions and summaries across API endpoints and models

python

docs(api): reword docstrings to present tense across resources

terraform

docs(api): update reservation_start_time description in beta_cluster

typescript

docs(api): improve docstring clarity and grammar across resources

Edit this comment to update them. They will appear in their respective SDK's changelogs.

togetherai-python studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ✅lint ✅test ⏭️

pip install https://pkg.stainless.com/s/togetherai-python/4423dd6a819d7c35e5227f961b9e74264e3015d7/together-2.12.0-py3-none-any.whl
togetherai-go studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ❗

go get github.com/stainless-sdks/togetherai-go@94cd0f46e8c1fe9da9139e35e4e5fbdd0d880890
togetherai-typescript studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ✅lint ✅test ❗

npm install https://pkg.stainless.com/s/togetherai-typescript/dc29652048a5e74544e00879cbc358e60cee38d8/dist.tar.gz
togetherai-openapi studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅

togetherai-terraform studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅lint ✅test ✅


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-08 16:13:10 UTC

@muhsinking muhsinking requested a review from blainekasten May 8, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant