Skip to content

docs: standardize language tab ordering + enforce in CI - #318

Draft
Aryex wants to merge 1 commit into
mainfrom
alexl/standardize-tab-ordering
Draft

Aryex wants to merge 1 commit into
mainfrom
alexl/standardize-tab-ordering

Conversation

@Aryex

@Aryex Aryex commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

Standardizes the ordering of language <TabItem> tabs across the docs to the canonical order defined in AGENTS.md:

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

Closes #182. Note: the issue predates the Ruby addition and lists …C#, PHP, but the current AGENTS.md (and the already-compliant pages) use PHP before C# with Ruby last. This PR follows the authoritative AGENTS.md order, and the scope is the full current set of deviations (26 files), not just the 15 originally listed.

Changes

  • Reordered 26 doc pages — all edits are pure <TabItem> block reorders; no code, prose, or labels changed (verified: sorted file contents are byte-identical to main).
  • Added enforcement (scripts/check-tab-order.mjs), since ordering was previously governed only by prose in AGENTS.md with no automated check:
    • New pnpm check:tab-order script.
    • New Static Checks CI step so out-of-order tabs fail PR checks.
    • Ignores non-language tabs (Gradle/Maven, Jedis/Glide, …), handles nested tabs, normalizes Node.jsNode, and skips languages a page doesn't cover.
  • Documented enforcement in AGENTS.md.

Testing

  • node scripts/check-tab-order.mjs → clean (it flagged all 62 pre-fix violations; 0 after).
  • Edge-case tested: correctly flags C#-before-PHP, Node.js normalization, single-quote labels, reversed order; correctly ignores non-language tabs, nested non-language tabs, and language subsets.
  • pnpm format:check → pass.
  • pnpm build → 111 pages, all internal links valid.

Reorder <TabItem> language tabs across 26 doc pages to the canonical
order Python -> Java -> Node -> Go -> PHP -> C# -> Ruby (per AGENTS.md).
All edits are pure block reorders; no code or prose changed.

Add scripts/check-tab-order.mjs to enforce the order, wired into the
`pnpm check:tab-order` script and the Static Checks CI workflow so
future deviations fail PR checks. Document enforcement in AGENTS.md.

Fixes #182

Signed-off-by: Alex Le <alex.le@improving.com>
@Aryex Aryex self-assigned this Aug 14, 2026
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.

Standardize language tab ordering across documentation

1 participant