Skip to content

Sentence-case the SDK community headings - #5141

Merged
Duncanma merged 2 commits into
mainfrom
docs/sentence-case-community-headings
Aug 19, 2026
Merged

Sentence-case the SDK community headings#5141
Duncanma merged 2 commits into
mainfrom
docs/sentence-case-community-headings

Conversation

@DABH

@DABH DABH commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

What

Sentence-cases the seven ## Get Connected with the Temporal <X> Community headings on the SDK landing pages, and promotes the TypeScript and Rust ones from h3 to h2.

File Before After
develop/go/index.mdx ## Get Connected with the Temporal Go Community ## Get connected with the Temporal Go community
develop/java/index.mdx ## ...Java Community ## ...Java community
develop/python/index.mdx ## ...Python Community ## ...Python community
develop/ruby/index.mdx ## ...Ruby Community ## ...Ruby community
develop/php/index.mdx ## ...PHP Community ## ...PHP community
develop/typescript/index.mdx ### ...TypeScript Community ## ...TypeScript community
develop/rust/index.mdx ### ...Rust Community ## ...Rust community

Why sentence case rather than a Vale exception

Temporal.Headings flagged all seven. I checked whether Community deserved an exception instead, and the repo's own sources say no:

  • readme/STYLE.md:91 — "Sentence casing means that only proper nouns and the first letter of the first word are capitalized."
  • Community does not appear in vale/styles/Temporal/terms.yml or vocabularies/Temporal/accept.txt, so the repo does not treat it as a Temporal term.
  • Surrounding prose already writes "the Temporal community" in lowercase 10 times. The only capitalized instances were these seven headings.

Connected is a verb here, not a proper noun. Temporal and the SDK language names stay capitalized (both are in the Temporal.Headings exception list already).

Heading level

Five of the seven pages already used h2. TypeScript and Rust used h3, which nested them under the preceding "Temporal <X> technical resources" section. They're peer sections, not subsections, so this normalizes them to h2.

No URL impact

Docusaurus lowercases heading slugs, so the anchors are byte-identical before and after. Verified against github-slugger (the slugger Docusaurus uses) and then in the built HTML:

id=get-connected-with-the-temporal-python-community

unchanged, now on an <h2>. Nothing in docs/, src/, sidebars.js, or vercel.json links to these anchors either way, so no redirect is needed.

Checks

  • vale --config .vale-ci.ini on all seven files: 0 errors, 0 warnings, 0 suggestions (was 7 suggestions)
  • yarn build: passes
  • yarn check:orphans: no orphaned pages
  • yarn lint:mermaid: passes
  • Built HTML spot-checked for anchor text and heading level on the Python, TypeScript, and Rust pages

Related

┆Attachments: EDU-6988 Sentence-case the SDK community headings

Temporal.Headings flagged all seven "Get Connected with the Temporal <X>
Community" headings. Community is not a Temporal term: it's absent from
Temporal/terms.yml and the accept vocabulary, and the surrounding prose
already writes "the Temporal community" in lowercase. STYLE.md limits
heading capitals to proper nouns and the first word.

Also promotes the TypeScript and Rust headings from h3 to h2, matching the
other five SDK landing pages. They are peer sections, not subsections of
the technical resources heading above them.

Anchors are unchanged: the slugs already lowercased to
get-connected-with-the-temporal-<sdk>-community, verified against
github-slugger. Nothing in the repo links to them either way.

Slack link text such as "Temporal Go Community Slack" is left alone, since
that names the workspace rather than describing the community.
@DABH
DABH requested a review from a team as a code owner August 19, 2026 06:03
Copilot AI balanced review requested due to automatic review settings August 19, 2026 06:03
@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview Aug 19, 2026 3:59pm

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates SDK landing-page community headings to sentence case and correct peer-section hierarchy.

Changes:

  • Sentence-cases seven community headings.
  • Promotes TypeScript and Rust headings from H3 to H2.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/develop/go/index.mdx Sentence-cases the Go community heading.
docs/develop/java/index.mdx Sentence-cases the Java community heading.
docs/develop/php/index.mdx Sentence-cases the PHP community heading.
docs/develop/python/index.mdx Sentence-cases the Python community heading.
docs/develop/ruby/index.mdx Sentence-cases the Ruby community heading.
docs/develop/rust/index.mdx Sentence-cases and promotes the Rust community heading.
docs/develop/typescript/index.mdx Sentence-cases and promotes the TypeScript community heading.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Duncanma
Duncanma enabled auto-merge (squash) August 19, 2026 15:58
@Duncanma
Duncanma merged commit 7c309e3 into main Aug 19, 2026
14 checks passed
@Duncanma
Duncanma deleted the docs/sentence-case-community-headings branch August 19, 2026 15:59
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.

3 participants