Skip to content

Standardize language tab ordering across documentation #182

@currantw

Description

@currantw

Summary

Language tab groups across the documentation use inconsistent ordering. The standard order is Python, Java, Node, Go, C#, PHP, but 15 files deviate from this.

Description

An audit of all <Tabs> / <ParamTabs> language tab groups in src/content/docs/ found that the most common ordering is:

Python → Java → Node → Go → C# → PHP

However, 15 files use a different order. The deviations fall into a few categories:

PHP and C# swapped (C# should come before PHP):

  • getting-started/basic-operations.mdx (lines 29, 198, 308)
  • getting-started/quickstart.mdx (lines 186, 381)
  • how-to/client-initialization.mdx (lines 20, 122, 154, 190)
  • how-to/connections/timeouts-and-reconnect-strategy.mdx (lines 19, 117)
  • how-to/send-batch-commands.mdx (lines 23, 235, 449, 634)
  • how-to/publish-and-subscribe-messages.mdx (lines 28, 118, 341, 506, 683, 871, 1035)
  • reference/connection-options.mdx (line 28)

Completely non-standard order:

  • how-to/connections/configure-lazy-connection.mdx — Node, Python, Java, Go, C#, PHP
  • how-to/connections/limit-inflight-requests.mdx — C#, Go, Java, Node, PHP, Python (alphabetical)
  • how-to/modules-api.mdx — C#, Java, Node, Python
  • how-to/monitoring/logging.mdx — Python, Node, C#, Java, PHP
  • how-to/monitoring/tracking-resources.mdx — Python, Java, Node, C#, PHP
  • how-to/security/dynamic-authentication.mdx — Java, Node, Python, Go, C#, PHP
  • how-to/security/iam-integration.mdx — C#, Python, Java, Node, Go, PHP
  • concepts/architecture/async-execution.mdx — Python, Node, Java, Go, PHP

This inconsistency can confuse users who expect to find their language in the same position across pages.

Proposed Solution

Reorder all <TabItem> elements in the affected files to match the standard order: Python, Java, Node, Go, C#, PHP. This is a content-only change with no logic impact. Pages that are missing certain languages should preserve the relative order of the languages they do include (e.g., Python, Java, Node, Go is fine if C# and PHP aren't present).

Effort & Severity Estimates

  • Effort: medium
  • Severity: low

Related

None

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions