diff --git a/README.md b/README.md index db8dd9eac..26d4c546f 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,14 @@ Whole library is documented as markdown documents: - [Documentation: Index](/docs/README.mdx#prologue) - [Dependencies](/docs/dependencies.mdx#dependencies) - [Supported Compilers](/docs/supported-compilers.mdx#supported-compilers) -- [Building: TinyORM](/docs/building-tinyorm.mdx#building-tinyorm) -- [Building: Migrations](/docs/building-migrations.mdx#building-migrations) -- [Building: Hello world](/docs/building-hello-world.mdx#building-hello-world) - [Database: Getting Started](/docs/database.mdx#database-getting-started) - [Database: Query Builder](/docs/query-builder.mdx#database-query-builder) - [Database: Migrations](/docs/migrations.mdx#database-migrations) - [TinyORM: Getting Started](/docs/tinyorm.mdx#tinyorm-getting-started) - [TinyORM: Relationships](/docs/tinyorm-relationships.mdx#tinyorm-relationships) +- [Building: TinyORM](/docs/building-tinyorm.mdx#building-tinyorm) +- [Building: Hello world](/docs/building-hello-world.mdx#building-hello-world) +- [Building: Migrations](/docs/building-migrations.mdx#building-migrations) [action-msvc]: https://github.com/silverqx/TinyORM/actions/workflows/msvc.yml [action-msvc-badge]: https://github.com/silverqx/TinyORM/actions/workflows/msvc.yml/badge.svg diff --git a/docs/README.mdx b/docs/README.mdx index 730cf6e81..8a26e1a2d 100644 --- a/docs/README.mdx +++ b/docs/README.mdx @@ -14,11 +14,11 @@ The code is well tested with the unit and functional tests. Almost all the query - [Dependencies](dependencies.mdx) - [Supported Compilers](supported-compilers.mdx) -- [Building: TinyORM](building-tinyorm.mdx) -- [Building: Migrations](building-migrations.mdx) -- [Building: Hello world](building-hello-world.mdx) - [Database: Getting Started](database.mdx) - [Database: Query Builder](query-builder.mdx) - [Database: Migrations](migrations.mdx) - [TinyORM: Getting Started](tinyorm.mdx) - [TinyORM: Relationships](tinyorm-relationships.mdx) +- [Building: TinyORM](building-tinyorm.mdx) +- [Building: Hello world](building-hello-world.mdx) +- [Building: Migrations](building-migrations.mdx) diff --git a/docs/building-hello-world.mdx b/docs/building-hello-world.mdx index 0e3603205..8ca161db6 100644 --- a/docs/building-hello-world.mdx +++ b/docs/building-hello-world.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 9 description: Hello world example created in the terminal and QtCreator IDE. --- diff --git a/docs/building-migrations.mdx b/docs/building-migrations.mdx index 91eb109ba..65ffcad52 100644 --- a/docs/building-migrations.mdx +++ b/docs/building-migrations.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 10 description: How to compile the TinyORM migrations (tom) c++ console application on Windows and Linux. --- diff --git a/docs/building-tinyorm.mdx b/docs/building-tinyorm.mdx index 1e4319eef..bc4997d7b 100644 --- a/docs/building-tinyorm.mdx +++ b/docs/building-tinyorm.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 8 hide_table_of_contents: true description: How to compile the TinyORM c++ library on Windows and Linux. --- diff --git a/docs/database.mdx b/docs/database.mdx index a558026ba..8ae0945d1 100644 --- a/docs/database.mdx +++ b/docs/database.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 3 description: TinyORM makes interacting with a database extremely simple using raw SQL, a fluent query builder, and the TinyORM. It provides first-party support for three databases MySQL/MariaDB, PostgreSQL, and SQLite. --- diff --git a/docs/migrations.mdx b/docs/migrations.mdx index 3a5b45e9f..9662750c1 100644 --- a/docs/migrations.mdx +++ b/docs/migrations.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 5 description: Migrations are like version control for your database, allowing your team to define and share the application's database schema definition. Migrations use the Schema facade that provides database agnostic support for creating and manipulating tables across all of TinyORM's supported database systems. --- diff --git a/docs/query-builder.mdx b/docs/query-builder.mdx index 09a905677..d123521a4 100644 --- a/docs/query-builder.mdx +++ b/docs/query-builder.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 4 description: TinyORM's database query builder provides a convenient, fluent interface to creating and running database queries. It can be used to perform most database operations in your application. The query builder uses QSqlQuery parameter binding to protect your application against SQL injection attacks. There is no need to clean or sanitize strings passed to the query builder as query bindings. --- diff --git a/docs/tinyorm-relationships.mdx b/docs/tinyorm-relationships.mdx index ee0af5a2e..1e7c4c53f 100644 --- a/docs/tinyorm-relationships.mdx +++ b/docs/tinyorm-relationships.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 7 description: TinyORM relationships are defined as methods on your TinyORM model classes. Since relationships also serve as powerful query builders, defining relationships as methods provides powerful method chaining and querying capabilities. --- diff --git a/docs/tinyorm.mdx b/docs/tinyorm.mdx index f34b54a7e..791749bb0 100644 --- a/docs/tinyorm.mdx +++ b/docs/tinyorm.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 6 description: TinyORM is an object-relational mapper (ORM) that makes it enjoyable to interact with your database. When using TinyORM, each database table has a corresponding "Model" that is used to interact with that table. In addition to retrieving records from the database table, TinyORM models allow you to insert, update, and delete records from the table as well. ---