Improve documentation structure and content #307
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sidebar changes: - Restructure Ingestion Reference: Language Clients first, then Message Brokers, then Protocols - Remove PGWire from Ingestion Reference (it's primarily for querying) - Move Java Embedded under Protocols Introduction page: - New pitch highlighting low-latency, high-throughput, time-series SQL extensions, open formats (Parquet), AI-ready - Updated use cases: capital markets, fintech, crypto, energy, space exploration, robotics Why QuestDB page: - New intro emphasizing open source, multi-tier storage, low-latency analytics - Depersonalized bullet points (removed "You" pattern) - Added petabyte-scale storage with multi-tier architecture - Added capital markets/crypto capabilities section with links - Updated use cases table: Capital markets, Banking, Aerospace, Energy PGWire documentation: - Restructured to lead with querying (primary use case) - Added "Query examples" section header - Moved INSERT examples to bottom of page - Updated intro to clarify querying vs ingestion Other improvements: - Renamed "Schema design essentials" to "Schema design" everywhere - Updated Guides component: Create database first, replaced Schema design with Ingestion overview - Updated PGWire client descriptions to be query-focused and consistent length - Replaced Cube with Polars in SQL overview 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
🤖 Component Converter ReminderA component in We are creating markdown correspondents of every path (e.g. questdb.com/docs/quick-start → questdb.com/docs/quick-start/index.md) for LLM consumption. Quick Check
💡 This is a friendly reminder, not a blocker. Ignore if not applicable. |
|
🚀 Build success! Latest successful preview: https://preview-307--questdb-documentation.netlify.app/docs/ Commit SHA: 9c97855
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Improvements to documentation structure, navigation, and content based on review of PR #301.
Sidebar changes
Introduction page
Why QuestDB page
PGWire documentation
Other improvements
Test plan
🤖 Generated with Claude Code