Skip to content

docs(concepts): add illustrations and improve concept pages #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
bluestreak01 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(concepts): add illustrations and improve concept pages #331

bluestreak01 wants to merge 2 commits into from

Conversation

@bluestreak01
Copy link
Member

@bluestreak01 bluestreak01 commented Jan 17, 2026

Summary

  • Add consistent SVG illustrations to four concept pages with unified styling matching the window-functions animation
  • Restructure and improve content for better clarity and organization
  • All illustrations use IBM Plex fonts and consistent color palette (#1b1c26, #51535f, #32343e, #e289a4, #0cc0df)

Changes by page

/docs/concepts/designated-timestamp/

  • Add animated SVG showing rows flowing into time-based partitions
  • Animation demonstrates how designated timestamp determines partition placement

/docs/concepts/partitions/

  • Restructure content: "Why partition" moved to top, new "Choosing a partition interval" section with guidance table
  • Add static illustration showing partition directories with column files
  • Condense splitting/squashing section

/docs/concepts/ttl/

  • Complete rewrite with clearer structure
  • Add timeline illustration showing TTL window and partition dropping
  • Document wall-clock protection feature from PR #6531
  • Add practical guidelines table

/docs/concepts/deduplication/

  • Add animated SVG showing INSERT/REPLACE/SKIP behavior
  • Animation demonstrates deduplication with UPSERT KEYS

Test plan

  • Verify all four pages render correctly in preview
  • Check animations work smoothly (designated-timestamp, deduplication)
  • Confirm illustrations display properly in dark mode
  • Review content accuracy

🤖 Generated with Claude Code

bluestreak01 and others added 2 commits January 17, 2026 01:32
@bluestreak01 @claude
docs(concepts): add illustrations and improve concept pages
08ab580 
Add consistent SVG illustrations to concept pages with unified styling
matching the window-functions animation (IBM Plex fonts, consistent
color palette).

Changes:
- designated-timestamp: Add animated SVG showing rows flowing to partitions
- partitions: Restructure content, add illustration showing partition
  directories with column files
- ttl: Rewrite with clearer structure, add timeline illustration,
  document wall-clock protection feature
- deduplication: Add animated SVG showing INSERT/REPLACE/SKIP behavior

All illustrations use consistent styling:
- IBM Plex Mono/Sans fonts
- Color palette: #1b1c26, #51535f, #32343e, #e289a4, #0cc0df
- Grid lines and table structure matching window-functions page

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@bluestreak01
Merge branch 'main' into vi_concept_ovr
d815fc7
@github-actions
Copy link

github-actions bot commented Jan 17, 2026 •
edited
Loading

🚀 Build success!

Latest successful preview: https://preview-331--questdb-documentation.netlify.app/docs/

Commit SHA: d815fc7

📦 Build generates a preview & updates link on each commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bluestreak01