Skip to content

Conversation

BohuTANG
Copy link
Member

Summary

Restructured the query documentation with a hierarchical learning path organization, following Snowflake's documentation approach for better user experience.

Changes

Documentation Structure

  • Reorganized flat structure into learning path hierarchy:
    • 00-basics/ - Basic query operations
    • 01-combining-data/ - JOINs, CTEs, subqueries
    • 02-advanced/ - UDFs, external functions, sequences, stored procedures
    • 03-optimization/ - Query profiling and performance

Content Improvements

  • Simplified CTE documentation with practical examples
  • Enhanced JOIN documentation with output examples for each type
  • Created separate subqueries guide with comprehensive examples
  • Added recursive CTE examples with clear explanations
  • Removed dictionary functionality (deprecated)

Navigation & UX

  • Removed "Next Steps" sections to reduce navigation noise
  • Added sidebar positioning for consistent ordering
  • Updated redirect rules for backward compatibility
  • Verified all SQL examples using MCP Databend

Key Features

  • Progressive learning path from basics to advanced
  • Practical examples with expected outputs
  • Streamlined content focused on user needs
  • Maintained backward compatibility with redirects

Test Plan

  • ✅ All SQL examples validated with Databend
  • ✅ Navigation structure verified
  • ✅ Redirect rules tested
  • ✅ Content organization reviewed

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

Copy link

vercel bot commented Aug 24, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Aug 24, 2025 1:00pm

Remove external links from DDL documentation to query guides to maintain independence between SQL reference and user guides sections. This fixes build failures caused by broken links after query guides restructuring.

Changes:
- Remove references to query-profile from EXPLAIN and monitoring docs
- Replace external links with inline examples in CREATE FUNCTION docs
- Update stored procedure references to use DDL documentation
- Remove guide links from aggregating index and dictionary functions
- Update UDF link paths to match new hierarchical structure

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@BohuTANG BohuTANG merged commit 7bdf08a into main Aug 24, 2025
4 checks passed
@BohuTANG BohuTANG deleted the improve-query-guides-structure branch August 24, 2025 13:02
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