ContextQMD
Back to Questdb

QuestDB Documentation Restructure Mapping

docs-restructure-mapping.md

latest18.0 KB
Original Source

QuestDB Documentation Restructure Mapping

This document maps current file paths to their new locations based on sidebar hierarchy. The goal is to align URL slugs with the navigation structure for better UX, SEO, and LLM comprehension.

Principles

  1. URL = Navigation path: A page's URL should reflect where it sits in the sidebar
  2. Predictable URLs: Users and LLMs should be able to guess URLs based on topic
  3. SEO-friendly: Clear hierarchy helps search engines understand content relationships

Root Level (No change needed)

Current PathNew PathNotes
introduction.mdintroduction.mdOK - root level
guides/schema-design-essentials.mdschema-design-essentials.mdMove to root (appears at root in sidebar)

Getting Started

Current PathNew PathNotes
quick-start.mdxgetting-started/quick-start.mdx
third-party-tools/llm-coding-assistants.mdgetting-started/llm-coding-assistants.md
operations/capacity-planning.mdgetting-started/capacity-planning.md
guides/create-database.mdgetting-started/create-database.md
operations/migrate-to-enterprise.mdgetting-started/migrate-to-enterprise.md
guides/enterprise-quick-start.mdgetting-started/enterprise-quick-start.md

Getting Started > Web Console

Current PathNew PathNotes
web-console.mdgetting-started/web-console/overview.mdRename to overview
web-console/code-editor.mdgetting-started/web-console/code-editor.md
web-console/metrics-view.mdgetting-started/web-console/metrics-view.md
web-console/schema-explorer.mdgetting-started/web-console/schema-explorer.md
web-console/result-grid.mdgetting-started/web-console/result-grid.md
web-console/query-log.mdgetting-started/web-console/query-log.md
web-console/import-csv.mdgetting-started/web-console/import-csv.md
web-console/create-table.mdgetting-started/web-console/create-table.md

Ingestion Reference

Current PathNew PathNotes
ingestion-overview.mdingestion/overview.md

Ingestion > Language Clients

Current PathNew PathNotes
configuration-string.mdingestion/clients/configuration-string.md
clients/ingest-python.mdingestion/clients/python.mdSimplify name
clients/ingest-go.mdingestion/clients/go.mdSimplify name
clients/java-ilp.mdingestion/clients/java.mdSimplify name
clients/ingest-rust.mdingestion/clients/rust.mdSimplify name
clients/ingest-node.mdingestion/clients/nodejs.mdSimplify name
clients/ingest-c-and-cpp.mdingestion/clients/c-and-cpp.md
clients/ingest-dotnet.mdingestion/clients/dotnet.mdSimplify name
clients/date-to-timestamp-conversion.mdingestion/clients/date-to-timestamp-conversion.md

Ingestion > Message Brokers

Current PathNew PathNotes
third-party-tools/kafka.mdingestion/message-brokers/kafka.md
third-party-tools/telegraf.mdingestion/message-brokers/telegraf.md
third-party-tools/redpanda.mdingestion/message-brokers/redpanda.md
third-party-tools/flink.mdingestion/message-brokers/flink.md

Ingestion > Protocols > ILP

Current PathNew PathNotes
reference/api/ilp/overview.mdingestion/ilp/overview.md
reference/api/ilp/columnset-types.mdingestion/ilp/columnset-types.md
reference/api/ilp/advanced-settings.mdingestion/ilp/advanced-settings.md

Ingestion > Protocols > Other

Current PathNew PathNotes
reference/api/java-embedded.mdingestion/java-embedded.md

Ingestion > CSV Import

Current PathNew PathNotes
guides/import-csv.mdingestion/import-csv.md

Query & SQL Reference

Current PathNew PathNotes
reference/sql/overview.mdquery/overview.md

Query > PostgreSQL Wire Protocol

Current PathNew PathNotes
pgwire/pgwire-intro.mdquery/pgwire/overview.mdRename to overview
pgwire/large-result-sets.mdquery/pgwire/large-result-sets.md
pgwire/python.mdquery/pgwire/python.md
pgwire/go.mdquery/pgwire/go.md
pgwire/java.mdquery/pgwire/java.md
pgwire/rust.mdquery/pgwire/rust.md
pgwire/javascript.mdquery/pgwire/nodejs.mdRename for consistency
pgwire/c-sharp.mdquery/pgwire/dotnet.mdRename for consistency
pgwire/php.mdquery/pgwire/php.md
pgwire/rpostgres.mdquery/pgwire/r.mdSimplify name
pgwire/c-and-cpp.mdquery/pgwire/c-and-cpp.md

Query > REST API

Current PathNew PathNotes
reference/api/rest.mdquery/rest-api.md

Query > Export

Current PathNew PathNotes
guides/export-parquet.mdquery/export-parquet.md

Query > Data Types

Current PathNew PathNotes
reference/sql/datatypes.mdquery/datatypes/overview.md
concept/array.mdquery/datatypes/array.md
concept/decimal.mdquery/datatypes/decimal.md
concept/geohashes.mdquery/datatypes/geohashes.md

Query > SQL Syntax

All files in reference/sql/ (except datatypes.md and overview.md) should move to query/sql/:

Current PathNew Path
reference/sql/acl/*.mdquery/sql/acl/*.md
reference/sql/alter-*.mdquery/sql/alter-*.md
reference/sql/asof-join.mdquery/sql/asof-join.md
reference/sql/cancel-query.mdquery/sql/cancel-query.md
reference/sql/case.mdquery/sql/case.md
reference/sql/cast.mdquery/sql/cast.md
reference/sql/checkpoint.mdquery/sql/checkpoint.md
reference/sql/compile-view.mdquery/sql/compile-view.md
reference/sql/copy.mdquery/sql/copy.md
reference/sql/create-*.mdquery/sql/create-*.md
reference/sql/declare.mdquery/sql/declare.md
reference/sql/distinct.mdquery/sql/distinct.md
reference/sql/drop*.mdquery/sql/drop*.md
reference/sql/explain.mdquery/sql/explain.md
reference/sql/fill.mdquery/sql/fill.md
reference/sql/group-by.mdquery/sql/group-by.md
reference/sql/insert.mdquery/sql/insert.md
reference/sql/join.mdquery/sql/join.md
reference/sql/latest-on.mdquery/sql/latest-on.md
reference/sql/limit.mdquery/sql/limit.md
reference/sql/order-by.mdquery/sql/order-by.md
reference/sql/over.mdquery/sql/over.md
reference/sql/refresh-mat-view.mdquery/sql/refresh-mat-view.md
reference/sql/reindex.mdquery/sql/reindex.md
reference/sql/rename.mdquery/sql/rename.md
reference/sql/sample-by.mdquery/sql/sample-by.md
reference/sql/select.mdquery/sql/select.md
reference/sql/show.mdquery/sql/show.md
reference/sql/snapshot.mdquery/sql/snapshot.md
reference/sql/truncate.mdquery/sql/truncate.md
reference/sql/union-except-intersect.mdquery/sql/union-except-intersect.md
reference/sql/update.mdquery/sql/update.md
reference/sql/vacuum-table.mdquery/sql/vacuum-table.md
reference/sql/where.mdquery/sql/where.md
reference/sql/window-join.mdquery/sql/window-join.md
reference/sql/with.mdquery/sql/with.md

Query > SQL Execution Order

Current PathNew PathNotes
concept/sql-execution-order.mdquery/sql-execution-order.md

Query > Functions

All files in reference/function/ should move to query/functions/:

Current PathNew Path
reference/function/aggregation.mdquery/functions/aggregation.md
reference/function/array.mdquery/functions/array.md
reference/function/binary.mdquery/functions/binary.md
reference/function/boolean.mdquery/functions/boolean.md
reference/function/conditional.mdquery/functions/conditional.md
reference/function/date-time.mdquery/functions/date-time.md
reference/function/finance.mdquery/functions/finance.md
reference/function/hash.mdquery/functions/hash.md
reference/function/json.mdquery/functions/json.md
reference/function/meta.mdquery/functions/meta.md
reference/function/numeric.mdquery/functions/numeric.md
reference/function/parquet.mdquery/functions/parquet.md
reference/function/pattern-matching.mdquery/functions/pattern-matching.md
reference/function/random-value-generator.mdquery/functions/random-value-generator.md
reference/function/row-generator.mdquery/functions/row-generator.md
reference/function/spatial.mdquery/functions/spatial.md
reference/function/text.mdquery/functions/text.md
reference/function/timestamp-generator.mdquery/functions/timestamp-generator.md
reference/function/timestamp.mdquery/functions/timestamp.md
reference/function/touch.mdquery/functions/touch.md
reference/function/trigonometric.mdquery/functions/trigonometric.md
reference/function/uuid.mdquery/functions/uuid.md
reference/function/window.mdquery/functions/window.md

Query > Operators

All files in reference/operators/ should move to query/operators/:

Current PathNew Path
reference/operators/bitwise.mdquery/operators/bitwise.md
reference/operators/comparison.mdquery/operators/comparison.md
reference/operators/date-time.mdquery/operators/date-time.md
reference/operators/ipv4.mdquery/operators/ipv4.md
reference/operators/logical.mdquery/operators/logical.md
reference/operators/misc.mdquery/operators/misc.md
reference/operators/numeric.mdquery/operators/numeric.md
reference/operators/precedence.mdquery/operators/precedence.md
reference/operators/spatial.mdquery/operators/spatial.md
reference/operators/text.mdquery/operators/text.md

Concepts

Concepts > Core Concepts

Current PathNew PathNotes
concept/designated-timestamp.mdconcepts/designated-timestamp.md
guides/working-with-timestamps-timezones.mdconcepts/timestamps-timezones.mdSimplify name
concept/partitions.mdconcepts/partitions.md
concept/symbol.mdconcepts/symbol.md
concept/views.mdconcepts/views.md
concept/mat-views.mdconcepts/materialized-views.mdClearer name
concept/deduplication.mdconcepts/deduplication.md
concept/ttl.mdconcepts/ttl.md
concept/write-ahead-log.mdconcepts/write-ahead-log.md

Concepts > Deep Dive

Current PathNew PathNotes
concept/indexes.mdconcepts/deep-dive/indexes.md
concept/interval-scan.mdconcepts/deep-dive/interval-scan.md
concept/jit-compiler.mdconcepts/deep-dive/jit-compiler.md
concept/query-tracing.mdconcepts/deep-dive/query-tracing.md
concept/sql-extensions.mdconcepts/deep-dive/sql-extensions.md
concept/sql-optimizer-hints.mdconcepts/deep-dive/sql-optimizer-hints.md
concept/root-directory-structure.mdconcepts/deep-dive/root-directory-structure.md

Architecture

Current PathNew PathNotes
guides/architecture/overview.mdxarchitecture/overview.mdx
guides/architecture/storage-engine.mdarchitecture/storage-engine.md
guides/architecture/memory-management.mdarchitecture/memory-management.md
guides/architecture/query-engine.mdarchitecture/query-engine.md
guides/architecture/time-series-optimizations.mdarchitecture/time-series-optimizations.md
guides/architecture/observability.mdarchitecture/observability.md

Configuration

Current PathNew PathNotes
configuration.mdconfiguration/overview.md
operations/command-line-options.mdconfiguration/command-line-options.md

Security

Current PathNew PathNotes
operations/rbac.mdsecurity/rbac.md
operations/openid-connect-oidc-integration.mdxsecurity/oidc.mdxSimplify name
operations/tls.mdsecurity/tls.md

High Availability

Current PathNew PathNotes
concept/replication.mdhigh-availability/overview.md
operations/replication.mdhigh-availability/setup.mdClearer name
guides/replication-tuning.mdhigh-availability/tuning.mdSimplify name

Operations

These files stay in operations/ (already aligned):

Current PathNew PathNotes
operations/backup.mdoperations/backup.mdOK
operations/logging-metrics.mdoperations/logging-metrics.mdOK
operations/monitoring-alerting.mdoperations/monitoring-alerting.mdOK
operations/data-retention.mdoperations/data-retention.mdOK
operations/updating-data.mdoperations/updating-data.mdOK
operations/modifying-data.mdoperations/modifying-data.mdOK
operations/task-automation.mdoperations/task-automation.mdOK

Deployment

Current PathNew PathNotes
deployment/docker.mddeployment/docker.mdOK
deployment/kubernetes.mddeployment/kubernetes.mdOK
deployment/systemd.mddeployment/systemd.mdOK
deployment/aws.mddeployment/aws.mdOK
deployment/azure.mddeployment/azure.mdOK
deployment/gcp.mddeployment/gcp.mdOK
deployment/digital-ocean.mddeployment/digital-ocean.mdOK
deployment/hetzner.mddeployment/hetzner.mdOK
guides/compression-zfs.mddeployment/compression-zfs.md

Integrations

Current PathNew PathNotes
third-party-tools/overview.mdintegrations/overview.md

Integrations > Visualization

Current PathNew PathNotes
third-party-tools/grafana.mdintegrations/visualization/grafana.md
third-party-tools/qstudio.mdintegrations/visualization/qstudio.md
third-party-tools/superset.mdintegrations/visualization/superset.md
third-party-tools/powerbi.mdintegrations/visualization/powerbi.md
third-party-tools/embeddable.mdintegrations/visualization/embeddable.md

Integrations > Data Processing

Current PathNew PathNotes
third-party-tools/pandas.mdintegrations/data-processing/pandas.md
third-party-tools/polars.mdintegrations/data-processing/polars.md
third-party-tools/spark.mdintegrations/data-processing/spark.md

Integrations > Orchestration

Current PathNew PathNotes
third-party-tools/airflow.mdintegrations/orchestration/airflow.md
third-party-tools/dagster.mdintegrations/orchestration/dagster.md

Integrations > Other Tools

Current PathNew PathNotes
third-party-tools/prometheus.mdintegrations/other/prometheus.md
third-party-tools/sqlalchemy.mdintegrations/other/sqlalchemy.md
third-party-tools/mindsdb.mdintegrations/other/mindsdb.md
third-party-tools/databento.mdintegrations/other/databento.md
third-party-tools/cube.mdintegrations/other/cube.md
third-party-tools/ignition.mdintegrations/other/ignition.md
third-party-tools/airbyte.mdintegrations/other/airbyte.md

Tutorials

Current PathNew PathNotes
guides/order-book.mdtutorials/order-book.md
guides/influxdb-migration.mdtutorials/influxdb-migration.md

Troubleshooting

Current PathNew PathNotes
troubleshooting/faq.mdtroubleshooting/faq.mdOK
operations/profiling.mdtroubleshooting/profiling.md
troubleshooting/os-error-codes.mdtroubleshooting/os-error-codes.mdOK
troubleshooting/error-codes.mdtroubleshooting/error-codes.mdOK

Directories to Delete After Migration

These directories will be empty after migration and should be removed:

  • clients/ (merged into ingestion/clients/)
  • concept/ (split between concepts/ and query/datatypes/)
  • guides/ (distributed to appropriate sections)
  • pgwire/ (moved to query/pgwire/)
  • reference/ (moved to query/)
  • third-party-tools/ (split between ingestion/message-brokers/ and integrations/)
  • web-console/ (moved to getting-started/web-console/)

Summary Statistics

  • Total files to move: ~150
  • New directories to create: ~25
  • Old directories to remove: 7
  • Files already in correct location: ~15 (deployment/, some operations/, troubleshooting/*)

Migration Order

  1. Create new directory structure
  2. Move files (preserving git history with git mv)
  3. Update sidebars.js with new paths
  4. Update any internal links between documents
  5. Add redirects for old URLs (in docusaurus.config.js)
  6. Remove empty old directories
  7. Test build and verify all links work