Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

This PR comprehensively updates code block syntax highlighting across the entire documentation site by replacing generic ````text` blocks with appropriate language identifiers.

Changes Made

  • Shell/Bash commands: text` → bash` (~120+ instances)

    • Installation commands, Docker commands, curl/API calls
    • Package managers (npm, pnpm, apt-get, yum, brew)
    • Database client commands (psql, mysql)
  • SQL queries: text` → sql` (~25+ instances)

    • Database queries and statements
  • Configuration files: `````text` → appropriate format

    • `````hcl` for Terraform configuration (4 instances)
    • ini`/conf` for config files (3 instances)
  • Kept as `````text`: Plain text content where appropriate

    • Bytebase-specific condition expressions
    • File structures, version strings, error messages

Files Updated (28 total)

Core Documentation:

  • README.md
  • API tutorials and integration guides
  • Deployment guides (Docker, Kubernetes)
  • Database change management documentation

Reference Documentation:

  • PostgreSQL: 3 files, 43 code blocks
  • MySQL: 4 files, 56 code blocks
  • MongoDB: 1 file, 1 code block
  • ClickHouse: 2 files, 18 code blocks

Blog Content:

  • 5 blog posts with technical content

Impact

This improvement provides:

  • ✨ Better syntax highlighting for all code examples
  • 📖 Improved readability and user experience
  • 🎯 Easier copy-paste functionality for developers
  • 🎨 Visual consistency across the documentation

Test plan

  • All files compile and render correctly
  • Syntax highlighting works as expected for different languages
  • No broken code blocks or formatting issues
  • Documentation site builds successfully

🤖 Generated with Claude Code

Replace generic ```text blocks with appropriate language identifiers
for better syntax highlighting and readability:

- Update shell/bash commands to use ```bash
- Update SQL queries to use ```sql
- Update configuration files to use ```ini, ```yaml, ```hcl
- Keep plain text content as ```text where appropriate

This improves the developer experience by providing proper syntax
highlighting for code examples throughout the documentation.

Files updated:
- README.md and core documentation
- API tutorials and integration guides
- Database reference documentation (PostgreSQL, MySQL, MongoDB, ClickHouse)
- Blog posts with technical content
- Deployment and configuration guides

Total: 28 files changed with ~200+ code blocks updated

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings August 13, 2025 09:45
@vercel
Copy link

vercel bot commented Aug 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Preview Comment Aug 13, 2025 9:48am

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@github-actions
Copy link

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

Copy link
Member

@tianzhou tianzhou left a comment

Choose a reason for hiding this comment

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

LGTM

@d-bytebase d-bytebase merged commit d722533 into main Aug 13, 2025
5 checks passed
@d-bytebase d-bytebase deleted the fix/improve-code-block-syntax-highlighting branch August 13, 2025 09:49
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