Fix architecture pages typos and inconsistencies (#192)

puzpuzpuz · web-flow · commit f80179775fa9 · 2025-05-28T11:50:06.000-07:00
diff --git a/documentation/guides/architecture/memory-management.md b/documentation/guides/architecture/memory-management.md
@@ -43,6 +43,3 @@ QuestDB leverages both memory mapping and explicit memory management techniques,
 - Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
 - [QuestDB GitHub Repository](https://github.com/questdb/questdb)
 - [QuestDB Documentation](/docs)
-
-
-
diff --git a/documentation/guides/architecture/networking-layer.md b/documentation/guides/architecture/networking-layer.md
@@ -29,7 +29,7 @@ might be incompatible if they rely heavily on PostgreSQL metadata, as QuestDB im
 overview of some key differences on QuestDB schema design, please visit our
 [Schema Design Essentials](/docs/guides/schema-design-essentials/) guide.
 
-The default port number for the pg-wire interface is `8812`.
+The default port number for the PGWire interface is `8812`.
 
 ### HTTP Rest API
 
@@ -50,5 +50,3 @@ The default port number for the minimal HTTP server is `9003`.
 - Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
 - [QuestDB GitHub Repository](https://github.com/questdb/questdb)
 - [QuestDB Documentation](/docs)
-
-
diff --git a/documentation/guides/architecture/observability.md b/documentation/guides/architecture/observability.md
@@ -40,4 +40,3 @@ QuestDB provides real-time metrics, a health check endpoint, and logging to moni
 - Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
 - [QuestDB GitHub Repository](https://github.com/questdb/questdb)
 - [QuestDB Documentation](/docs)
-
diff --git a/documentation/guides/architecture/overview.md b/documentation/guides/architecture/overview.md
@@ -34,7 +34,7 @@ QuestDB is comprised of several key components:
   QuestDB is specifically designed for time-series, and it provides several optimizations, such as a designated timestamp, sequential reads, materialized views, and in-memory processing.
 
 - **[Data ingestion engine](/docs/guides/architecture/data-ingestion):**
-  TSupports both bulk and streaming ingestion. It writes data to a row-based write-ahead
+  Supports both bulk and streaming ingestion. It writes data to a row-based write-ahead
   log (WAL) and then converts it into a columnar format. In QuestDB Enterprise, the WAL segments
   are shipped to object storage for replication.
 
@@ -56,8 +56,6 @@ QuestDB is comprised of several key components:
   The engine includes a web console for running SQL statements, bulk loading CSV files, and displaying monitoring dashboards. QuestDB Enterprise supports single sign-on (SSO) in the web console.
 
 
-
-
 ## Design patterns & best practices throughout the codebase
 
 - **Immutable data structures:**
diff --git a/documentation/guides/architecture/query-engine.md b/documentation/guides/architecture/query-engine.md
@@ -51,7 +51,7 @@ to process data in table page frames for better CPU use.
 />
 
 - **JIT compilation and Vectorized processing:**
-  Queries with a `WHERE` clause [compile](/docs/concept/jit-compiler) critical parts of the execution plan to native machine code (SIMD AVX-2 instructions) just in time. Vectorised instructions apply
+  Queries with a `WHERE` clause [compile](/docs/concept/jit-compiler) critical parts of the execution plan to native machine code (SIMD AVX-2 instructions) just in time. Vectorized instructions apply
   the same operation to many data elements simultaneously. This maximizes CPU cache use and reduces overhead.
 
 - **Multi-threaded execution:**
diff --git a/documentation/guides/architecture/replication-layer.md b/documentation/guides/architecture/replication-layer.md
@@ -28,7 +28,7 @@ primary to replicate changes to the object store, even if there are no read repl
 could be used for point-in-time recovery.
 
 For demanding scenarios, QuestDB Enterprise allows [multi-primary ingestion](/docs/operations/multi-primary-ingestion/),
-which allows both increasing the write throughput, and enabling high availabilty. In order to enable multi-primary ingestion,
+which allows both increasing the write throughput, and enabling high availability. In order to enable multi-primary ingestion,
 a `Distributed Sequencer` instance will need to be created.
 
 
@@ -57,4 +57,3 @@ across primaries.
 - Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
 - [QuestDB GitHub Repository](https://github.com/questdb/questdb)
 - [QuestDB Documentation](/docs)
-
diff --git a/documentation/guides/architecture/security.md b/documentation/guides/architecture/security.md
@@ -11,10 +11,10 @@ description: QuestDB implements enterprise-grade security with TLS, single-sign-
   fine-grained granularity.
 
 - **Built-in admin and read-only users:**
-  QuestDB includes built-in admin and read-only users for the pgwire protocol and HTTP endpoints using HTTP Basic Auth.
+  QuestDB includes built-in admin and read-only users for the PGWire protocol and HTTP endpoints using HTTP Basic Auth.
 
 - **HTTP basic authentication:**
-  You can enable HTTP Basic Authentication for the HTTP API, web console, and pgwire
+  You can enable HTTP Basic Authentication for the HTTP API, web console, and PGWire
   protocol. Health-check and metrics endpoints can be configured independently.
 
 - **Token-based authentication:**
diff --git a/documentation/guides/architecture/storage-engine.md b/documentation/guides/architecture/storage-engine.md
@@ -27,7 +27,7 @@ concurrent data ingestion, modifications, and schema changes without locking the
 appears consistent to all readers, even during ongoing write operations.
 
 
-- **TableWriter**: Changes stored in the WAL are stored in columnar format by the TableWriter. The TableWriter
+- **TableWriter**: Changes in the WAL are stored in columnar format by the TableWriter. The TableWriter
 also handles and resolves out-of-order data writes, and enables deduplication. Column files use an
 [append model](/docs/concept/storage-model/).
 
diff --git a/documentation/guides/architecture/time-series-optimizations.md b/documentation/guides/architecture/time-series-optimizations.md
@@ -67,7 +67,7 @@ sequential reads, materialized-views, or in-memory processing.
 
   - QuestDB supports materialized views for `SAMPLE BY` queries, including those joining with other tables.
 
-  - Materialized sampled intervals are automatically refreshed whenever the base table receivews new or updated rows.
+  - Materialized sampled intervals are automatically refreshed whenever the base table receives new or updated rows.
 
   - Materialized views can be chained, with the output of one being the input of another one, and support TTLs for lifecycle management.
 
@@ -107,12 +107,10 @@ Varchar data (column file):
 +---+---+---+---+---+---+---+---+---+---+---+
 | H | e | l | l | o |   | w | o | r | l | d |
 +---+---+---+---+---+---+---+---+---+---+---+
-
 ```
 
 ## Next Steps
 
 - Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
 - [QuestDB GitHub Repository](https://github.com/questdb/questdb)
 - [QuestDB Documentation](/docs)
-
