Skip to content

docs(window-functions): restructure into dedicated section with improved navigation#319

Merged
bluestreak01 merged 12 commits intomainfrom
vi_window
Jan 13, 2026
Merged

docs(window-functions): restructure into dedicated section with improved navigation#319
bluestreak01 merged 12 commits intomainfrom
vi_window

Conversation

@bluestreak01
Copy link
Copy Markdown
Member

@bluestreak01 bluestreak01 commented Jan 11, 2026

Summary

  • Reorganize window functions documentation from scattered pages into a dedicated "Window Functions" category under Functions
  • Create clear entry point with improved navigation for both humans and LLMs
  • Add documentation for CUMULATIVE shorthand and other previously undocumented features
  • Add cross-links between WINDOW JOIN and window functions to clarify the distinction
  • Replace vwap() function with practical VWAP example using window functions
  • Document WINDOW JOIN GROUP BY limitation with workaround pattern

Changes

New Structure

Functions/
└── Window Functions/
    ├── Overview      (entry point - concepts, quick reference, patterns)
    ├── Function Reference (all 12 functions documented)
    └── OVER Syntax   (frame types, boundaries, CUMULATIVE)

Files Added

  • documentation/query/functions/window-functions/overview.md
  • documentation/query/functions/window-functions/reference.md
  • documentation/query/functions/window-functions/syntax.md
  • static/_redirects (Netlify redirects for old URLs)

Files Removed

  • documentation/query/functions/window.md
  • documentation/query/sql/over.md

Files Updated

  • documentation/sidebars.js - new nested category
  • documentation/integrations/visualization/powerbi.md - updated links
  • documentation/query/sql/explain.md - updated links
  • documentation/query/overview.md - updated links
  • documentation/query/sql/window-join.md - added disambiguation note + GROUP BY limitation with CTE workaround
  • documentation/query/functions/finance.md - replaced vwap() function with redirect to VWAP example

Improvements

  • Single entry point: Users searching "window functions" now land on a clear overview page
  • Quick reference table: Shows all functions with "Respects Frame" indicator
  • New documentation: CUMULATIVE shorthand, frame shorthand syntax, time-series optimization tips
  • Real-world VWAP example: Using OHLC data with typical price formula (high + low + close) / 3
  • Clear disambiguation: Notes distinguishing WINDOW JOIN (cross-table) from window functions (same table)
  • GROUP BY limitation: Explicit documentation that WINDOW JOIN doesn't support GROUP BY, with CTE workaround pattern
  • Better organization: Concepts → Reference → Syntax details
  • LLM-friendly: Keywords in frontmatter, structured content, cross-links, clear limitations

Redirects

Old URL New URL
/docs/query/functions/window/ /docs/query/functions/window-functions/overview/
/docs/query/sql/over/ /docs/query/functions/window-functions/syntax/

Test plan

  • Verify all three new pages render correctly
  • Check sidebar navigation shows nested "Window Functions" category
  • Confirm internal links work (powerbi, explain, overview pages)
  • Test redirects work on Netlify deploy preview
  • Verify WINDOW JOIN page shows disambiguation note and GROUP BY limitation
  • Confirm finance.md VWAP section links to window functions example

🤖 Generated with Claude Code

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 11, 2026

🚀 Build success!

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

Commit SHA: e834eda

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

…ved navigation

Reorganize window functions documentation from scattered pages into a dedicated
"Window Functions" category under Functions for better discoverability.

Changes:
- Create new window-functions/ directory with three focused pages:
  - overview.md: Entry point with concepts, quick reference table, common patterns
  - reference.md: Complete function reference (avg, sum, count, rank, lag, lead, etc.)
  - syntax.md: OVER clause syntax, frame types, CUMULATIVE shorthand
- Remove old scattered pages (window.md, over.md)
- Update sidebar navigation with new nested category
- Update internal links in powerbi.md, explain.md, overview.md
- Add Netlify redirects for old URLs

Improvements:
- Single clear entry point for users searching "window functions"
- Quick reference table showing all functions with "Respects Frame" indicator
- Document CUMULATIVE shorthand and frame shorthand syntax
- Add time-series optimization tips
- Add VWAP example
- Better organized content: concepts -> reference -> syntax details

Co-Authored-By: Claude Opus 4.5 <[email protected]>
bluestreak01 and others added 9 commits January 12, 2026 14:14
- Add frame_start and frame_end syntax definitions to syntax.md
- Add syntax synopsis section to overview.md for newcomers
- Fix incorrect RANGE frame limitation description (issue #5177)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Adds visual animation to help newcomers understand how window
functions slide through rows.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add syntax to main syntax block
- Add dedicated section with examples and use cases
- Mention supported functions: first_value, last_value, lag, lead
- Add brief mention in overview syntax section

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Explain that calculations reset for each partition
- Add "When to use it" with capital markets examples
- Add side-by-side SQL comparison (with/without partition)
- Add table showing difference in results per symbol

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Replace car race analogy with concrete aggregate vs window function
comparison showing:
- Source data table
- Aggregate query and result (1 row)
- Window function query and result (all rows)
- Capital markets terminology (BTC-USD trades)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Window function arithmetic (e.g., division between two window
functions) requires version 9.3.1+. Earlier versions need CTEs
or subqueries as workarounds.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
The SQL snippets already indicate they're demo-able via the UI.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Add SVG animation to static assets
- Reference local file instead of GitHub user-attachments URL

Co-Authored-By: Claude Opus 4.5 <[email protected]>
bluestreak01 and others added 2 commits January 13, 2026 19:25
Update links in 17 cookbook files to point to the new window functions
documentation location under /docs/query/functions/window-functions/.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@bluestreak01 bluestreak01 merged commit 99276b7 into main Jan 13, 2026
2 checks passed
@bluestreak01 bluestreak01 deleted the vi_window branch January 13, 2026 20:16
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