Restructure documentation navigation for better discoverability #301
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
|
🚀 Build success! Latest successful preview: https://preview-301--questdb-documentation.netlify.app/docs/ Commit SHA: dbff9c7
|
Navigation: - Create top-level High Availability section (Enterprise) - Move replication docs from Concepts/Operations to High Availability - Sync sidebar labels (Overview, Setup Guide, Tuning) - Flatten single-item Integrations categories (Monitoring, Industrial) - Move Enterprise Quick Start to Getting Started - Promote Materialized Views to Core Concepts with Popular tag Content rewrites: - Rewrite replication Overview for clarity (concept/replication.md) - Rewrite Setup Guide - cleaner structure, 526→250 lines (operations/replication.md) - Rewrite Tuning guide - add quick reference, when to tune (guides/replication-tuning.md) - Enhance Schema Design with Materialized Views subsection and example 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Rewrite quick-start with Hello World example, fix ILP port (9000→9009) - Rewrite why-questdb with clear use cases and honest positioning - Rewrite schema-design-essentials with better structure and examples - Merge materialized views guide into concept page (single source) - Simplify symbol docs, remove outdated capacity emphasis - Rewrite deduplication docs with full-row check optimization - Rewrite WAL docs emphasizing HA/replication benefits - Consolidate storage-model into storage-engine (Architecture) - Consolidate replication-layer into High Availability section - Remove outdated GA notices from materialized view pages - Reorganize Concepts: Core Concepts + Deep Dive, move TTL/dedup to Core - Collapse ILP and PGWire sidebar sections by default 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Removed thin wrapper pages that duplicated content available elsewhere: - data-ingestion-engine.md (covered by Connect & Ingest section) - security.md (covered by top-level Security section) - networking-layer.md (covered by Connect & Ingest section) - web-console.md (covered by top-level Web Console section) Updated architecture overview to link directly to canonical pages. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
jerrinot
reviewed
Dec 23, 2025
jerrinot
reviewed
Dec 23, 2025
jerrinot
reviewed
Dec 23, 2025
Contributor
|
the deleted/moves pages should send redirects when accessed through the old URL. there is a netlify config file for this. |
jerrinot
reviewed
Dec 23, 2025
jerrinot
reviewed
Dec 23, 2025
jerrinot
reviewed
Dec 23, 2025
jerrinot
reviewed
Dec 23, 2025
RaphDal
reviewed
Dec 23, 2025
Contributor
RaphDal
left a comment
RaphDal
left a comment
There was a problem hiding this comment.
The documentation is much more pleasant to read.
There is a typo in the introduction page: effiency -> efficiency.
- Remove port 9009 from Docker run command - Update ports table to indicate 9009 is legacy TCP, use HTTP instead - Steer users toward more reliable HTTP-based ILP ingestion 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Member
Author
|
Fixed port 9009 comments in c36ddde:
|
- Swap WAL segment sizes: smaller = lower latency, larger = less traffic - Add 1s throttle window option for low latency scenarios - Clarify sequencer part size effects and trade-offs - Mark compression section as reference (not tunable) - Remove incorrect claims about defaults 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fix typo: "depending" -> "depend" in quick-start - Clarify that indexes are per-partition in indexes.md example 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update font stack to system fonts for better compatibility - Remove custom SegoeUI font files (~150KB saved) - Brighten link color (#79a8ff) for dark background legibility - Increase base font size from 15px to 16px 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…mance Introduction page: - Rewrite with concrete description and clear structure - Add "About this documentation" section (OSS vs Enterprise) - Simplify CTAs and add logical "Get started" flow Schema Design Essentials: - Add numeric types storage table - Add DECIMAL and ARRAY to types table - Fix BYTES → BINARY typo Datatypes reference: - Add Decimal section with performance info - Move Decimal section after N-dimensional array Decimal concept page: - Replace "Trade-offs" with "Performance" section - Document high-performance characteristics (~2x slower than double, faster than ClickHouse/DuckDB, non-allocating) Consolidation: - Delete design-for-performance.md (merged into schema-design-essentials) - Update all links pointing to design-for-performance - Update Guides component to use schema-design-essentials 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 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. |
Schema Design Essentials: - Add DuckDB migration example - Expand multi-tenancy with customer, environment, and department patterns - Split InfluxDB example into separate code blocks for proper highlighting 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replaces outdated "master_table/slave_table" terminology with "left_table/right_table" for consistency with other JOIN documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Sidebar: move ILP Advanced Settings to bottom, rename Data Types to Overview - Symbol: add dictionary encoding explanation, NOCACHE option, pre-9.0.0 note - Deduplication, WAL: use consistent capital markets examples (prices table) - Replication: simplify snapshot section, link to backup docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Views documentation: - Add concept/views.md with comprehensive coverage of views - Add SQL reference pages: CREATE VIEW, ALTER VIEW, DROP VIEW, COMPILE VIEW - Update show.md with SHOW CREATE VIEW - Update meta.md with views() function - Add sidebar entries for all new pages RBAC restructure: - Add Quick Start section for immediate usability - Add Access Control Depth section explaining database/table/column/row levels - Add Connection Access Granularity (HTTP/PGWIRE/ILP) - Add Common Scenarios section with task-based examples - Clarify service accounts vs users (testability, no inheritance) - Add row-level security with views examples - Move permission tables to collapsible reference section - Consolidate duplicate built-in admin sections - Preserve all anchor URLs for backward compatibility 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add swizzled DocSidebarItem/Link and DocSidebarItem/Category components to render customProps.tag as styled badges (Enterprise, Popular) - Move SQL Syntax from Query Data to top-level "SQL Reference" section - Consolidate Enterprise tags on category level (Security, High Availability, GRANT, REVOKE) instead of repeating on each child item 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Schema Design Essentials: - Add intro for new users - Add "Next steps" section with links to related pages - Remove WAL from examples (it's the default) - Update SYMBOL guidance (tens of millions distinct values supported) - Use capital markets examples throughout (trades, quotes, OHLC) Sidebar: - Remove "Popular" tag (unused) - Add "Recommended" tag for Schema Design Essentials - Rename tagPopular CSS to tagRecommended 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sidebar changes: - Move Introduction, Why QuestDB, Data Modeling Basics to top level - Rename "Connect & Ingest" to "Ingestion Reference" - Rename "Query Data" to "Query & SQL Reference" - Move SQL Syntax inside Query & SQL Reference after Data Types - Move REST API and PostgreSQL Wire Protocol to Query & SQL Reference - Collapse Getting Started, Data Types, SQL Syntax by default - Move Java Embedded to last in Ingestion Reference - Remove all Enterprise and Recommended tags from sidebar New EnterpriseNote component: - Custom styled callout for enterprise features - Brand colors, star icon, "Learn more" link - Added to all Security and High Availability pages Content improvements: - Rename Schema Design Essentials to Data Modeling Basics - Update introduction page with 4-step getting started flow - Add "Next up" navigation links to all Architecture pages - Fix typos in architecture docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Restore SegoeUI font files for navigation elements - Sidebar uses SegoeUI at 15px (original style) - Table of contents uses same font as sidebar - Main content keeps system fonts at 16px 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
4 tasks
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 <noreply@anthropic.com>
REST API remains in Query & SQL Reference section only. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Rename "Enterprise" to "QuestDB Enterprise" throughout (sidebar, navbar, pages) - Add multi-tier storage and automated backup to Enterprise features - Update introduction page: open source mention, cleaner formatting (no bullets) - Update enterprise-quick-start: remove redundant TOC bullets, use numbered links - Update ingestion-overview: focus on throughput/latency instead of high-cardinality - Update why-questdb: "Capital markets capabilities" (remove crypto mention) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add Resolution section to designated-timestamp explaining timestamp vs timestamp_ns - Move "Timestamps and time zones" under "Designated timestamp" in sidebar - Fix SQL syntax in timestamps guide (my_table; → SELECT * FROM my_table;) - Fix to_utc/to_timezone mismatch in timestamps guide - Add STRING vs VARCHAR deprecation section to schema-design-essentials - Fix code fence language consistency in enterprise-quick-start (sql → questdb-sql) - Fix malformed Java code block in enterprise-quick-start - Add missing "Further reading" references to enterprise-quick-start sections - Fix 3 broken links in enterprise-quick-start 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Typography: - Add Inter variable font for body text (17px) - Keep SegoeUI for sidebar/TOC navigation Fix 5 critical ambiguity issues to reduce LLM hallucination risk: 1. ILP timestamp naming (ilp/overview.md) - Made explicit: auto-created tables always use 'timestamp' column name - No client-side option to change this 2. Write amplification metrics (capacity-planning.md) - Added interpretation table with value ranges - Clarified these are cumulative lifetime counters 3. WAL/partitioning relationship (write-ahead-log.md) - Added table showing SQL vs ILP defaults - Explicit: WAL requires partitioning 4. Materialized view refresh (mat-views.md) - Clarified initial refresh is async full refresh - View returns no data until complete - Added query to check refresh status 5. Partition defaults (partitions.md) - Added prominent table: creation method → partition default → WAL support - Made implications explicit (dedup, replication) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
New content: - Add "Handling Large Result Sets" page with per-language examples for cursor-based fetching (Java, Python, Go, Node.js, .NET) - Add reference from pgwire-intro.md Content updates: - Rewrite introduction to be developer-facing, non-marketing - Remove "Why QuestDB" page (marketing content) Typography: - Reduce body font size to 15px 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove multi-primary ingestion documentation - Move modifying-data from Tutorials to Operations - Rename to "Update alternatives", cross-reference with "How UPDATE works" - Move CSV Import from Tutorials to Ingestion Reference - Fix grammar issues in updating-data.md and import-csv.md - Add ingestion characteristics section (throughput/latency, batching) - Simplify introduction, add architecture link - Add cross-references between REST API /imp and CSV Import guide 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Parquet Export: fix code block languages, rename title, move to Query & SQL Reference - ZFS Compression: fix grammar and command syntax, rename title, move to Deployment - Move qStudio from Other Tools to Visualization in Integrations 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Auto-size tables to content width (max-content) - Cap at 100% container width for wide tables - Border with rounded corners - Dark header background - Row hover effect - Set Infima table CSS variables 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- New page explaining how to use Claude Code with QuestDB - Covers: writing app code, building pipelines, querying, troubleshooting, migrations - Added to Getting Started section for new users - Collapsed Integrations subcategories by default 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Convert all SQL examples from IoT/sensors/trips to trades/prices/symbols - Add demo tags with titles to select.md examples - Fix PostHog optional chaining in CodeBlock component Files updated: - sample-by.md, designated-timestamp.md, symbol.md - create-database.md, aggregation.md, date-time.md - text.md, timestamp.md, group-by.md, latest-on.md - with.md, create-table.md, rest.md - grafana.md, powerbi.md, advanced-settings.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Remove max-width limit and add white-space: nowrap to prevent config property names from breaking at dots. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
Major documentation restructure to improve navigation and discoverability:
Navigation & Structure
New Content
SQL Examples Standardization
UI/UX Improvements
Content Improvements
Test Plan
🤖 Generated with Claude Code