Fix broken source links, typos, and Vale spelling noise - #5106
Merged
Conversation
- Correct sample repo links that pointed to renamed paths or nonexistent branches (samples-php default branch is master, not main; safe-message-handler samples were renamed/moved in samples-java, samples-dotnet, sdk-typescript, and temporal repos; pydantic_converter/v1 became pydantic_converter_v1 in samples-python) - Add thousands separators to two "1000 events" references
Fix subject-verb agreement and misspellings found while auditing Vale.Spelling output (e.g. "pattern apply" -> "pattern applies", "procss" -> "process", "Namepace" -> "Namespace", "occurence" -> "occurrence", "createing" -> "creating", "inforamtion" -> "information"). Also normalize "operationalise" to the American spelling used elsewhere. Vale.Spelling was producing ~7,000 flags across docs/, almost all false positives from legitimate technical vocabulary (SDK/product names, metric names, code identifiers). Populate accept.txt with these terms so the check is usable signal instead of noise; this took the flag count to zero and is what surfaced the typos above.
|
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}
| @@ -118,7 +118,7 @@ Temporal Cloud Namespace has a [Retention Period](/temporal-service/temporal-ser | |||
|
|
|||
| ### Availability and Disaster Recovery | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Availability and Disaster Recovery' should use sentence-style capitalization.
| Up to 1000 events can be downloaded from the Audit Log UI to a local file. | ||
| Up to 1,000 events can be downloaded from the Audit Log UI to a local file. | ||
|
|
||
| ## Access an Audit Log via API {/* #audit-log-api */} |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Access an Audit Log via API **********************' should use sentence-style capitalization.
| If the execution hits a call to `patched()` with an ID that doesn't exist in the history, then not only will it return `false` in that occurence, but it will also return `false` if the execution surpasses the Replay threshold and is running new code. | ||
| If the execution hits a call to `patched()` with an ID that doesn't exist in the history, then not only will it return `false` in that occurrence, but it will also return `false` if the execution surpasses the Replay threshold and is running new code. | ||
|
|
||
| #### Implications of the Behaviors |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Implications of the Behaviors' should use sentence-style capitalization.
Contributor
📖 Docs PR preview links
|
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes broken source links and documentation typos while expanding Vale’s accepted technical vocabulary.
Changes:
- Repairs links to renamed files, directories, branches, and external documentation.
- Corrects spelling, grammar, and number formatting.
- Adds approximately 895 terms to Vale’s spelling allowlist.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
vale/styles/config/vocabularies/Temporal/accept.txt |
Expands the Vale vocabulary. |
docs/production-deployment/self-hosted-guide/archival.mdx |
Fixes an archiver source link. |
docs/guides/recover-without-restart.mdx |
Corrects spelling and grammar. |
docs/guides/rate-limit-downstream-apis.mdx |
Updates the Stripe documentation link. |
docs/encyclopedia/workflow/patching.mdx |
Corrects “occurrence.” |
docs/encyclopedia/nexus/standalone-nexus-operation.mdx |
Corrects “Namespace.” |
docs/develop/python/best-practices/data-handling/data-conversion.mdx |
Fixes the Pydantic sample path. |
docs/develop/plugins-guide.mdx |
Fixes the OpenTelemetry plugin path. |
docs/develop/php/activities/asynchronous-activity.mdx |
Uses the PHP samples’ default branch. |
docs/develop/dotnet/workflows/message-passing.mdx |
Fixes the .NET sample path. |
docs/design-patterns/entity-workflow.mdx |
Fixes the Java sample path. |
docs/design-patterns/continue-as-new.mdx |
Formats 1,000 correctly. |
docs/cloud/projects.mdx |
Corrects “creating.” |
docs/cloud/manage-access/custom-roles.mdx |
Corrects “information.” |
docs/cloud/audit-logs.mdx |
Formats 1,000 correctly. |
docs/best-practices/security-controls.mdx |
Uses American spelling. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| workflow_type | ||
| xUnit | ||
| Zod | ||
| Akka |
| scheduled_event_id | ||
| schedule_to_close_timeout | ||
| schedule_to_start_timeout | ||
| scrapable |
flippedcoder
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
master, notmain; renamed dirs in samples-java, samples-dotnet, sdk-typescript, samples-python, and temporal), plus two "1000" → "1,000" formatting fixesvale/styles/config/vocabularies/Temporal/accept.txtwith ~450 legitimate technical terms (SDK/product names, metric names, code identifiers) that Vale's spelling check was flagging as unknown words — this took Vale.Spelling's output ondocs/from ~7,000 flags down to 0, which is what surfaced most of the typos aboveFollow-up worth considering
Vale.Spellingas a CI gate is now a realistic option — it was pure noise before this cleanup, but it's clean acrossdocs/as of this PR. Not done here since it's a policy decision (gate vs. advisory) rather than a content fix.Test plan
vale --config .vale-ci.inirun against every changed file: 0 errors, 0 warnings (only pre-existing heading-capitalization suggestions unrelated to these edits)yarn buildpasses (ran automatically via pre-commit hook on both commits)mastervia GitHub API before changingmain→masterin that link┆Attachments: EDU-6951 Fix broken source links, typos, and Vale spelling noise