diff --git a/docs/README.md b/docs/README.md index c703ec6..c647136 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ --- title: Cql +icon: database --- # Cql diff --git a/docs/coreconcepts/README.md b/docs/coreconcepts/README.md index add9211..d3d4c55 100644 --- a/docs/coreconcepts/README.md +++ b/docs/coreconcepts/README.md @@ -1,8 +1,12 @@ +--- +icon: lightbulb +--- + # Core Concepts CQL’s core concepts revolve around providing developers with tools to efficiently interact with databases through well-structured APIs. These concepts are fundamental to building and manipulating data models, performing queries, and managing transactions. Here's a high-level overview: -- **Schemas:** Define the structure of the database, including tables, columns, and data types. -- **CRUD Operations:** Simplify creating, reading, updating, and deleting records in the database. -- **Query Builder:** Enables constructing SQL queries using Crystal code with features like joins and subqueries. -- **Transactions:** Ensure safe and atomic execution of multiple database operations. +* **Schemas:** Define the structure of the database, including tables, columns, and data types. +* **CRUD Operations:** Simplify creating, reading, updating, and deleting records in the database. +* **Query Builder:** Enables constructing SQL queries using Crystal code with features like joins and subqueries. +* **Transactions:** Ensure safe and atomic execution of multiple database operations. diff --git a/docs/cql-api/README.md b/docs/cql-api/README.md index a825673..faed3a4 100644 --- a/docs/cql-api/README.md +++ b/docs/cql-api/README.md @@ -1,2 +1,6 @@ +--- +icon: webhook +--- + # Cql API diff --git a/docs/guides/README.md b/docs/guides/README.md index 3a42e34..5ecfd2d 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -1,3 +1,7 @@ +--- +icon: book +--- + # Guides The CQL (Crystal Query Language) Toolkit simplifies the management and execution of SQL queries in Crystal. It supports CRUD operations, complex query building, and uses patterns like Active Record and Repository for efficient data management. CQL is compatible with multiple databases, including PostgreSQL. Features include schema definition, query execution, data insertion, updating, and deletion. It also provides support for associations like has\_many, belongs\_to, and many\_to\_many. diff --git a/docs/installation.md b/docs/installation.md index a8f0e23..6c48d57 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,3 +1,7 @@ +--- +icon: gear +--- + # Installation To get started with CQL in your Crystal project, follow these steps: diff --git a/docs/introduction.md b/docs/introduction.md index 55b98cb..b6f4414 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,3 +1,7 @@ +--- +icon: arrow-right-to-arc +--- + # Introduction ## Purpose of CQL