fix(vale): sentence-case recurring headings; more Temporal.Headings exceptions - #4984
Draft
Duncanma wants to merge 2 commits into
Draft
fix(vale): sentence-case recurring headings; more Temporal.Headings exceptions#4984Duncanma wants to merge 2 commits into
Duncanma wants to merge 2 commits into
Conversation
…er-noun exceptions Content fixes for the recurring boilerplate headings duplicated across the per-SDK-language guide sets (Next Steps, Verify Success, Best Practices:, Considerations for Workflows with Message Handlers, the event-history "How Workflow ... " trio, etc.) plus a few one-off sentence-case fixes (Rate Limiting, Query Parameters, Namespace Versions, Create a Project) and formatting an inline code identifier in a heading (`GetVersion`) instead of leaving it as bare text. Also extends the Temporal.Headings exceptions with proper nouns found while auditing these fixes: brand/product names (Amazon, Google, Microsoft, S3), Temporal Cloud feature names (Ops, Audit, Log, Saved, View, Actions, Non-Deterministic), and the conventional "Hello World" programming idiom — all confirmed as consistently-capitalized terms used throughout the docs' prose. Live Temporal.Headings suggestions: 446 -> 340.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ### Best Practices: | ||
| ### Best practices: | ||
|
|
||
| #### 1. Use Private Connectivity |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] '1. Use Private Connectivity' should use sentence-style capitalization.
| @@ -95,7 +95,7 @@ A [Metric Family](https://github.com/prometheus/OpenMetrics/blob/main/specificat | |||
|
|
|||
| ## Client Considerations | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Client Considerations' should use sentence-style capitalization.
Contributor
📖 Docs PR preview links
|
Duncanma
marked this pull request as draft
July 28, 2026 22:59
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
1 participant
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
Follow-up to #4983. Two related changes, bundled since they serve the same goal (reducing
Temporal.Headingsfalse positives / noise):Amazon,Google,Microsoft,S3), Temporal Cloud feature names (Ops,Audit,Log,Saved,View,Actions,Non-Deterministic— all verified as consistently capitalized in prose, e.g. "Cloud Ops API", "Audit Log", "Saved View"), and theHello/Worldprogramming idiom used across every SDK's setup guide.Next Steps,Verify Success,Best Practices:,Considerations for Workflows with Message Handlers, theencyclopedia/event-history/*"How Workflow code maps to commands / How Workflow commands map to events / How History replay provides Durable Execution" trio, and a handful of one-offs (Rate Limiting,Query Parameters,Namespace Versions,Create a Project). Also formatted`GetVersion`as inline code in a heading instead of leaving it as bare prose text.Left the long tail of one-off headings (single-occurrence title-case violations, third-party proper nouns like PKCS8/Route 53/JUnit) out of scope for this pass.
Test plan
vale --config=.vale-ci.ini docs/— liveTemporal.Headingssuggestions drop from 446 to 340, 0 errorsvale --config=.vale-ci.ini vale/test/headings-good.md/headings-bad.md— new exceptions covered, no regressions.mdxfile with@mdx-js/mdxdirectly — all pass (2 pre-existing unrelated compile failures confirmed present onmainbefore this change too)┆Attachments: EDU-6837 fix(vale): sentence-case recurring headings; more Temporal.Headings exceptions