Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Remove numbered prefixes from section headings to prevent line wrapping
  • Reorganize comparison content under a unified "Compare" section with subsections for Schema Migration Tools and SQL Clients
  • Improve overall document structure and readability

Test plan

  • Verify headings no longer wrap on standard screen sizes
  • Confirm comparison sections are properly organized
  • Check that all links remain functional

🤖 Generated with Claude Code

- Remove numbered prefixes from section headings to avoid line wrapping
- Reorganize comparison sections under a unified "Compare" heading
- Improve document structure and readability

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

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

vercel bot commented Aug 27, 2025

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

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

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.

Pull Request Overview

This PR improves the readability of the introduction page by removing numbered prefixes from section headings and reorganizing the comparison content under a unified structure.

  • Remove "1." and "2." prefixes from main section headings to prevent line wrapping
  • Consolidate comparison sections under a single "Compare" heading with subsections
  • Maintain all existing content while improving document hierarchy

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@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

@tianzhou tianzhou merged commit 134e432 into main Aug 27, 2025
5 checks passed
@tianzhou tianzhou deleted the refactor-introduction-headings branch August 27, 2025 09:53
@tianzhou
Copy link
Member

CleanShot 2025-08-27 at 17 55 05@2x

A emoji on a separate line still looks not great

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