Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Removed 6 outdated screenshot images that were cluttering the documentation
  • Simplified the document structure by removing unnecessary section nesting
  • Improved clarity and conciseness of setup instructions

Changes

  • Removed image references and corresponding webp files for:
    • Read-only connection configuration
    • SSH tunnel architecture and setup
    • External secret manager flow
    • Vault secret creation and authentication
  • Consolidated "Advanced Options" and "Security Features" sections into main level headings
  • Rewrote descriptions to explain when to use each feature
  • Simplified setup instructions for better readability

Test plan

  • Preview the updated documentation page
  • Verify all remaining links work correctly
  • Confirm the page renders properly without the removed images

🤖 Generated with Claude Code

- Remove unnecessary image references and files from instance.mdx
- Consolidate Advanced Options and Security Features sections
- Improve clarity of SSH Tunnel and Secret Manager descriptions
- Simplify Read-Only Connections setup instructions
- Remove 6 outdated webp images that were cluttering the docs

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

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

vercel bot commented Aug 20, 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 20, 2025 2:46am

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 cleans up instance connection documentation by removing outdated visual elements and improving text clarity. The changes focus on making the documentation more concise and easier to navigate by eliminating image dependencies and simplifying section structure.

  • Removed 6 outdated screenshot images (webp files) and their references
  • Flattened section hierarchy by promoting subsections to main-level headings
  • Improved instructional text with clearer explanations of when and why to use features

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

@d-bytebase d-bytebase merged commit 11bc9fc into main Aug 20, 2025
5 checks passed
@d-bytebase d-bytebase deleted the cleanup-instance-docs-images branch August 20, 2025 02:46
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