cratedb.md (3)

7-7: Remove the blank line inside the blockquote.

There is a blank line inside the blockquote, which is flagged by markdown linting tools. Removing it will improve markdown rendering and lint compliance.

-> CrateDB also provides an HTTP interface, is written in Java, and brings
>
> together fundamental components to manage big data after the Hadoop and
> Spark batch-processing era, more like Teradata, BigQuery and Snowflake
> are doing it.
+> CrateDB also provides an HTTP interface, is written in Java, and brings
+> together fundamental components to manage big data after the Hadoop and
+> Spark batch-processing era, more like Teradata, BigQuery and Snowflake
+> are doing it.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

7-7: Blank line inside blockquote
null

(MD028, no-blanks-blockquote)

---

22-22: Convert bare URL to markdown link.

The bare URL for CrateDB Cloud can be converted to a markdown link for better readability and to comply with markdown linting rules.

-Get started with CrateDB Cloud at https://console.cratedb.cloud/.
+Get started with [CrateDB Cloud](https://console.cratedb.cloud/).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

22-22: Bare URL used
null

(MD034, no-bare-urls)

---

29-30: Consider varying sentence beginnings for improved readability.

Several consecutive sentences in the Docs, API, and Examples sections begin with the same word ("CrateDB" or "CrateDB Cloud"). While not critical, varying sentence structure can improve readability and flow.

For example, instead of:

• "CrateDB reference documentation: The reference documentation of CrateDB."
• "CrateDB Cloud: The full documentation for CrateDB Cloud."

You could rephrase as:

• "Find the full reference documentation for CrateDB here."
• "Comprehensive documentation for CrateDB Cloud is available here."

This is optional but can enhance the document's style.

Also applies to: 40-41, 48-50

🧰 Tools

🪛 LanguageTool

[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...All features of CrateDB at a glance. - [CrateDB reference documentation](https://crated...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... reference documentation of CrateDB. - [CrateDB Cloud](https://cratedb.com/docs/cloud/e...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

cratedb.md (3)

27-30: Vary sentence beginnings for improved readability.

Several consecutive sentences start with "CrateDB" or "The". Consider rephrasing to improve flow, e.g.:

- [CrateDB database](...): Benefits of CrateDB at a glance.
- [CrateDB features](...): All features of CrateDB at a glance.
- [CrateDB reference documentation](...): The reference documentation of CrateDB.
- [CrateDB Cloud](...): The full documentation for CrateDB Cloud.
+ [CrateDB database](...): Overview of key benefits.
+ [Feature list](...): Comprehensive summary of CrateDB's capabilities.
+ [Reference documentation](...): In-depth technical details and usage.
+ [CrateDB Cloud docs](...): Complete documentation for managed deployments.

This is optional but will enhance readability for human users.

🧰 Tools

🪛 LanguageTool

[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...All features of CrateDB at a glance. - [CrateDB reference documentation](https://crated...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... reference documentation of CrateDB. - [CrateDB Cloud](https://cratedb.com/docs/cloud/e...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

38-42: Improve sentence variety for better flow.

Multiple consecutive sentences begin with "CrateDB". For improved readability, consider rephrasing:

- [CrateDB SQL syntax](...): You can use Structured Query Language (SQL) to query your data.
- [CrateDB SQL functions](...): The reference documentation about all SQL functions CrateDB provides.
- [CrateDB drivers](...): How to connect to a CrateDB cluster using traditional database drivers. 
- [CrateDB cluster-wide settings](...): Cluster-wide settings can be read by querying the `sys.cluster.settings` column. Most cluster settings can be changed at runtime. 
- [CrateDB node-specific settings](...): Node-specific settings of CrateDB. 
+ [SQL syntax](...): Query your data using standard SQL.
+ [SQL functions](...): Reference for all built-in SQL functions.
+ [Database drivers](...): Connect to clusters using standard drivers.
+ [Cluster-wide settings](...): View and modify settings via `sys.cluster.settings`.
+ [Node-specific settings](...): Configuration options for individual nodes.

This is a stylistic suggestion to enhance human readability.

🧰 Tools

🪛 LanguageTool

[style] ~40-~40: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... all SQL functions CrateDB provides. - [CrateDB drivers](https://cratedb.com/docs/crate...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...using traditional database drivers. - [CrateDB cluster-wide settings](https://cratedb....

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

46-51: Consider varying sentence structure in the examples list.

Several consecutive entries begin with "CrateDB". For improved readability, consider rephrasing:

- [CrateDB SQL gallery](...): A collection of SQL queries and utilities suitable for diagnostics on CrateDB.
- [CrateDB GTFS / GTFS-RT Transit Data Demo](...): Capture GTFS and GTFS-RT data for storage and analysis with CrateDB.
- [CrateDB Offshore Wind Farms Demo Application](...): A CrateDB demo application using data from the UK's offshore wind farms.
- [CrateDB RAG / Hybrid Search PDF Chatbot](...): A chatbot powered by CrateDB using RAG techniques and data from PDF files.
- [CrateDB Geospatial Data Demo](...): Spatial data demo application using CrateDB and the Express framework.
- [Plane Spotting with Software Defined Radio, CrateDB and Node.js](...): Code for the Plane Spotting with Software Defined Radio, CrateDB and Node.js talk.
+ [SQL gallery](...): Diagnostic queries and utilities for CrateDB.
+ [GTFS / GTFS-RT Transit Data Demo](...): Capture and analyze transit data.
+ [Offshore Wind Farms Demo](...): Analyze UK wind farm data.
+ [RAG / Hybrid Search PDF Chatbot](...): Chatbot using RAG techniques and PDF data.
+ [Geospatial Data Demo](...): Spatial data analysis with Express.
+ [Plane Spotting with SDR and Node.js](...): Code for plane spotting and data ingestion.

This is optional but will improve the document's flow for human readers.

🧰 Tools

🪛 LanguageTool

[style] ~48-~48: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...r storage and analysis with CrateDB. - [CrateDB Offshore Wind Farms Demo Application](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~49-~49: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...a from the UK's offshore wind farms. - [CrateDB RAG / Hybrid Search PDF Chatbot](https:...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

---

[style] ~50-~50: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... techniques and data from PDF files. - [CrateDB Geospatial Data Demo](https://github.co...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro