Skip to content

Conversation

killme2008
Copy link
Contributor

@killme2008 killme2008 commented Aug 15, 2025

What's Changed in this PR

Describe the change in this PR

As the title said.

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@killme2008 killme2008 requested review from Copilot and removed request for fengjiachun and nicecui August 15, 2025 08:25
Copilot

This comment was marked as outdated.

Copy link

cloudflare-workers-and-pages bot commented Aug 15, 2025

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: d78ad96
Status: ✅  Deploy successful!
Preview URL: https://53b80b6a.greptime-docs.pages.dev
Branch Preview URL: https://feature-improve-faq.greptime-docs.pages.dev

View logs

Copy link
Contributor

@Copilot 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 FAQ documentation by restructuring and expanding content to provide more comprehensive guidance about GreptimeDB's capabilities, deployment options, and use cases. The update transforms a basic Q&A format into a detailed guide covering core capabilities, architecture, integrations, and best practices.

Key changes:

  • Complete restructuring of FAQ content with organized sections (Core Capabilities, Architecture & Performance, Integration & Compatibility, etc.)
  • Addition of detailed performance comparisons with specific metrics and benchmark data
  • Enhanced technical details about GreptimeDB's architecture, storage engine, and scalability features
  • Cross-references to FAQ from concept overview pages to improve discoverability

Reviewed Changes

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

Show a summary per file
File Description
i18n/zh/docusaurus-plugin-content-docs/current/faq-and-others/faq.md Complete rewrite of Chinese FAQ with comprehensive sections covering capabilities, performance, deployment, and technical details
docs/faq-and-others/faq.md Complete rewrite of English FAQ with expanded content matching the Chinese version structure
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/why-greptimedb.md Updates WAL description to mention flexible options and removes planned Python feature
docs/user-guide/concepts/why-greptimedb.md Same WAL description update as Chinese version
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/overview.md Adds FAQ link to concepts overview navigation
docs/user-guide/concepts/overview.md Adds FAQ link to concepts overview navigation
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md Fixes typos in section headers and adds FAQ cross-reference
docs/user-guide/concepts/features-that-you-concern.md Fixes typo in section header and adds FAQ cross-reference

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

@killme2008
Copy link
Contributor Author

After review, backport to v0.15 and v0.16. Don't merge it.

Copy link
Collaborator

@nicecui nicecui left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@nicecui nicecui merged commit 7de589d into main Aug 18, 2025
5 checks passed
@nicecui nicecui deleted the feature/improve-faq branch August 18, 2025 03:05
@nicecui nicecui mentioned this pull request Sep 3, 2025
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