Skip to content

Update quick-start.mdx for localization and clarity#3404

Open
dewanshshekhar wants to merge 1 commit intoapache:masterfrom
dewanshshekhar:master
Open

Update quick-start.mdx for localization and clarity#3404
dewanshshekhar wants to merge 1 commit intoapache:masterfrom
dewanshshekhar:master

Conversation

@dewanshshekhar
Copy link
Contributor

What

  • Added a warning message before the table creation example in the "Running Queries" section to emphasize that replication_num = 1 must be specified in single-backend/local environments
  • Added a new Q&A entry in the FAQ section to address common user errors

Why

  • New users following the quick-start guide often encounter errors because they overlook the replication_num parameter
  • This improvement helps users resolve issues faster and improves the overall documentation experience

Changes

  • ✅ Added a :::warning block explaining the necessity of replication_num = 1
  • ✅ Added a new FAQ entry to address common error handling

Versions

  • dev
  • 4.x
  • 3.x
  • 2.1

Languages

  • Chinese
  • English

Docs Checklist

  • Checked by AI
  • Test Cases Built

### What
- Added a warning message before the table creation example in the "Running Queries" section to emphasize that `replication_num = 1` must be specified in single-backend/local environments
- Added a new Q&A entry in the FAQ section to address common user errors

### Why
- New users following the quick-start guide often encounter errors because they overlook the replication_num parameter
- This improvement helps users resolve issues faster and improves the overall documentation experience

### Changes
- ✅ Added a :::warning block explaining the necessity of `replication_num = 1`
- ✅ Added a new FAQ entry to address common error handling
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.

1 participant