Skip to content

docs: add docs and update logo - #120

Merged
tianzhou merged 7 commits into
bytebase:mainfrom
tianzhou:tmp
Nov 12, 2025
Merged

tianzhou merged 7 commits into
bytebase:mainfrom
tianzhou:tmp

Conversation

@tianzhou

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings November 12, 2025 09:19
@tianzhou
tianzhou merged commit 3c242ac into bytebase:main Nov 12, 2025
8 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 adds comprehensive documentation for DBHub and updates branding assets. The changes include removing old logo files, adding new logo variants in different formats and color schemes, creating integration guides for various AI tools, and simplifying existing documentation pages.

Key Changes

  • Replaced logo files with new designs in multiple variants (full, icon, text-only in light/dark modes)
  • Added integration documentation for Claude Desktop, Claude Code, Cursor, and VS Code
  • Simplified installation and introduction pages by removing verbose content
  • Removed unused documentation template files

Reviewed Changes

Copilot reviewed 27 out of 45 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
resources/images/logo-*.svg Removed old logo files
docs/images/logo/*.svg Added new logo variants in SVG format
docs/images/logo-full.webp Added webp logo for web use
docs/images/*.webp, *.png Added screenshots and hero images
docs/integrations/*.mdx Created integration guides for Claude Desktop, Claude Code, Cursor, and VS Code
docs/installation.mdx Reorganized with npm installation prioritized over Docker
docs/index.mdx Simplified introduction with logo path updates
docs/quickstart.mdx Removed description field
docs/snippets/snippet-intro.mdx Removed snippet content
docs/essentials/*.mdx Removed template documentation files

Comment thread docs/quickstart.mdx
Comment on lines 1 to 3
---
title: "Quickstart"
description: "Get DBHub running and connected to an AI tool in minutes"
---

Copilot AI Nov 12, 2025

Copy link

Choose a reason for hiding this comment

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

The removal of the description field from the frontmatter may impact SEO and documentation discoverability. Consider adding back a concise description such as: description: 'Get DBHub running and connected to an AI tool in minutes'

Copilot uses AI. Check for mistakes.
Comment thread docs/installation.mdx
Comment on lines 1 to 3
---
title: "Installation"
description: "Install DBHub using Docker, NPM, or as a standalone binary"
---

Copilot AI Nov 12, 2025

Copy link

Choose a reason for hiding this comment

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

The removal of the description field from the frontmatter may impact SEO. Consider adding a description like: description: 'Install DBHub using npm or Docker'

Copilot uses AI. Check for mistakes.
Comment thread docs/index.mdx
Comment on lines 1 to 3
---
title: "Introduction"
description: "Universal Database MCP Server implementing the Model Context Protocol"
---

Copilot AI Nov 12, 2025

Copy link

Choose a reason for hiding this comment

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

The removal of the description field from the frontmatter may negatively impact SEO and search engine indexing. Consider adding back a description such as: description: 'Universal Database MCP Server implementing the Model Context Protocol'

Copilot uses AI. Check for mistakes.
@tianzhou
tianzhou deleted the tmp branch December 3, 2025 08:25
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.

2 participants