Skip to content

docs(builder): Improve CLI command formatting in builder docs#780

Open
hungtk wants to merge 1 commit intoTanStack:mainfrom
hungtk:docs/improve-builder-cli-formatting
Open

docs(builder): Improve CLI command formatting in builder docs#780
hungtk wants to merge 1 commit intoTanStack:mainfrom
hungtk:docs/improve-builder-cli-formatting

Conversation

@hungtk
Copy link

@hungtk hungtk commented Mar 24, 2026

Description

This PR improves the formatting and accessibility of the TanStack Builder documentation by refining the CLI command display.

Changes:

  • CLI Command Formatting: Wrapped the npx @tanstack/cli create command in a <code> block within the <pre> container for better semantic structure.
  • Improved Contrast: Explicitly styled the CLI text using text-gray-800 (light) and dark:text-gray-200 (dark) to ensure clarity against the code block background.

Verifications:

The following tests were run and passed successfully:

  • TypeScript validation (tsc)
  • Linting checks (eslint)
  • Smoke tests for the home page and core library documentation routes (pnpm test:smoke)

@netlify
Copy link

netlify bot commented Mar 24, 2026

👷 Deploy request for tanstack pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 3d29924

@coderabbitai
Copy link

coderabbitai bot commented Mar 24, 2026

📝 Walkthrough

Walkthrough

The CLI command example in the documentation was restructured to render the command as an explicit <code> element within a <pre> block, replacing an earlier backtick string approach. This DOM structure change includes updated styling classes while preserving the visible command text.

Changes

Cohort / File(s) Summary
Documentation Structure
src/routes/builder.docs.tsx
Refactored CLI command example rendering in "Using the CLI" section from backtick string to explicit <code> element with updated class styling.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A CLI command stands so proud,
Now wrapped in <code> like a cloud,
The pre-block gleams with newfound grace,
Same words, but better HTML space! 🐰✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: improving CLI command formatting in the builder documentation by wrapping the command in a code block for better semantic HTML.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant