Skip to content

[docs] Improve POC guide structure and query pitfalls#3469

Merged
dataroaring merged 2 commits intomasterfrom
before_poc
Mar 16, 2026
Merged

[docs] Improve POC guide structure and query pitfalls#3469
dataroaring merged 2 commits intomasterfrom
before_poc

Conversation

@dataroaring
Copy link
Contributor

Summary

  • Nest "Example Templates" under "Table Design" since they are CREATE TABLE examples illustrating the design decisions above
  • Rewrite query pitfalls in action-oriented style to match the load section ("Avoid...", "Don't...")
  • Add over-bucketing pitfall (up to 50% query perf degradation)
  • Add under-bucketing pitfall (limited CPU parallelism)
  • Expand sort key pitfall: explain 36-byte prefix truncation behavior differs from PostgreSQL, recommend inverted indexes
  • Update Chinese translation with all the same changes

Test plan

  • Verify EN page renders correctly at /docs/dev/gettingStarted/before-you-start-the-poc
  • Verify zh-CN page renders correctly
  • Check all anchor links (#bucketing, #sort-key) resolve correctly

🤖 Generated with Claude Code

- Nest Example Templates under Table Design section
- Rewrite query pitfalls in action-oriented style matching load section
- Add over-bucketing pitfall (up to 50% perf degradation)
- Add under-bucketing pitfall (limited CPU parallelism)
- Expand sort key pitfall with prefix truncation behavior vs PostgreSQL
- Update Chinese translation to match

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 16, 2026 11:45
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

Reorganizes the “Before You Start the POC” documentation to better reflect table-design hierarchy and expands the “Query” pitfalls section with additional bucketing and sort-key guidance, keeping the zh-CN translation in sync.

Changes:

  • Nested “Example Templates / 建表模板” under the “Table Design / 建表设计” section by adjusting heading levels.
  • Rewrote query pitfalls into action-oriented guidance and added over-/under-bucketing pitfalls.
  • Expanded the sort key pitfall to clarify Doris prefix-index behavior and recommend inverted indexes for non-prefix columns (EN + zh-CN).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/gettingStarted/before-you-start-the-poc.md Adjusts heading hierarchy and enhances “Query” pitfalls with bucketing + sort-key guidance and cross-links.
i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/before-you-start-the-poc.md Mirrors the same structural and content updates in the Chinese translation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dataroaring dataroaring merged commit 5a0acca into master Mar 16, 2026
1 check passed
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