Regenerate tcld command reference docs (fix grammar template) - #5119
Merged
Conversation
Fixes the "The `tcld namespace capacity` command manage namespace capacity." grammar error and similar cases across the tcld reference, plus restores the plain-English e.g./i.e. wording from a prior hand patch that a straight regeneration would have reverted. The actual fix is in the gen-docs tool template in the tcld repo (unmerged PR temporalio/tcld#499); this just copies its corrected output into the docs repo. Fixes #5113
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links |
Duncanma
marked this pull request as ready for review
August 14, 2026 22:07
Duncanma
enabled auto-merge (squash)
August 14, 2026 22:08
lennessyy
approved these changes
Aug 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #5113 — the tcld reference pages under
docs/cloud/tcld/had grammar errors like:These pages are auto-generated, so the real fix is in the
gen-docstool template in thetemporalio/tcldrepo, not here. That fix is in tcld#499 (unmerged — the repo isn't getting many updates). This PR copies that PR's corrected output into this repo.Changes in tcld#499's
cmd/gen-docs/main.go:"The `%s` command %s."(withlowercaseFirst) with"`%s`: %s.", so the sentence reads correctly whether the sourceUsagestring is a noun phrase or an imperative verb.for example/that iswording in threeUsagestrings (app/apikey.go,app/namespace.go) that a straight regeneration would have silently reverted, since those two generated pages had been hand-patched for the Latin-abbreviation cleanup in Replace Latin abbreviations in hand-written docs #5100.Why draft
This is blocked on tcld#499 (or the competing tcld#398) actually merging — per AGENTS.md, opening as draft until that lands. Marking ready for review once it does.
Test plan
vale --config .vale-ci.ini docs/cloud/tcld/— 0 errors/warnings/suggestionsyarn build— succeeds, no MDX/broken-link errorsdocs/cloud/tcld/*.mdx: every change is either the template fix or legitimate drift from newer tcld commands since the docs were last generated; no unexpected regressions┆Attachments: EDU-6963 Regenerate tcld command reference docs (fix grammar template)