Skip to content

Commit

Permalink
Refactor directory structure for Cql API documentation
Browse files Browse the repository at this point in the history
Revised the docs/SUMMARY.md to reflect a new directory structure,
moving all Cql API documentation files from 'cql-1' to 'cql' directory.
Deleted redundant files under 'cql-1' to maintain a cleaner and more
organized documentation hierarchy.

This change improves the maintainability of the documentation by
simplifying the folder structure and aligning it with standard naming
conventions. No functional code is affected, ensuring backward
compatibility with previous documentation references.
  • Loading branch information
eliasjpr committed Aug 18, 2024
1 parent 80f5e31 commit d80a64c
Show file tree
Hide file tree
Showing 30 changed files with 50 additions and 3,702 deletions.
100 changes: 50 additions & 50 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
# Table of contents

* [Cql](README.md)
* [Guides](guides/README.md)
* [Introduction](guides/introduction.md)
* [Installation](guides/installation.md)
* [Core Concepts](guides/coreconcepts/README.md)
* [DB Schema](guides/coreconcepts/schemas.md)
* [Initializing the Database](guides/coreconcepts/initializing-the-database.md)
* [Altering the Schema](guides/coreconcepts/altering-the-schema.md)
* [Migrations](guides/coreconcepts/migrations.md)
* [CRUD Operations](guides/coreconcepts/crud-operations/README.md)
* [Creating Records](guides/coreconcepts/crud-operations/creating-records.md)
* [Reading Records](guides/coreconcepts/crud-operations/reading-records.md)
* [Updating Records](guides/coreconcepts/crud-operations/updating-records.md)
* [Deleting Records](guides/coreconcepts/crud-operations/deleting-records.md)
* [Patterns](guides/coreconcepts/patterns/README.md)
* [Entity Framework](guides/coreconcepts/patterns/entity-framework.md)
* [Active Record](guides/coreconcepts/patterns/active-record/README.md)
* [Records](guides/coreconcepts/patterns/active-record/records.md)
* [Relations](guides/coreconcepts/patterns/active-record/relations.md)
* [Collections](guides/coreconcepts/patterns/active-record/collections.md)
* [Repository](guides/coreconcepts/patterns/repository.md)
* [Cql API](cql-1/README.md)
* [enum Cql::Adapter](cql-1/adapter.md)
* [class Cql::AlterTable](cql-1/altertable.md)
* [class Cql::Column(T)](cql-1/column.md)
* [class Cql::Delete](cql-1/delete.md)
* [class Cql::Error](cql-1/error.md)
* [class Cql::ForeignKey](cql-1/foreignkey.md)
* [class Cql::Insert](cql-1/insert.md)
* [class Cql::Migration](cql-1/migration.md)
* [class Cql::Migrator](cql-1/migrator.md)
* [class Cql::PrimaryKey(T)](cql-1/primarykey.md)
* [alias Cql::PrimaryKeyType](cql-1/primarykeytype.md)
* [class Cql::Query](cql-1/query.md)
* [module Cql::Record(T, Pk)](cql-1/record.md)
* [module Cql::Relations](cql-1/relations.md)
* [class Cql::Repository(T, Pk)](cql-1/repository.md)
* [class Cql::Schema](cql-1/schema.md)
* [class Cql::Table](cql-1/table.md)
* [class Cql::Update](cql-1/update.md)
* [class Cql::Index](cql-1/\_index.md)
* [Migrator](cql-1/migrator-1/README.md)
* [Cql::Migrator::MigrationRecord](cql-1/migrator-1/migrationrecord.md)
* [Relations](cql-1/relations-1/README.md)
* [module Cql::Relations::BelongsTo](cql-1/relations-1/belongsto.md)
* [class Cql::Relations::Collection(Target, Pk)](cql-1/relations-1/collection.md)
* [module Cql::Relations::HasMany](cql-1/relations-1/hasmany.md)
* [module Cql::Relations::HasOne](cql-1/relations-1/hasone.md)
* [class Cql::Relations::ManyCollection(Target, Through, Pk)](cql-1/relations-1/manycollection.md)
* [module Cql::Relations::ManyToMany](cql-1/relations-1/manytomany.md)
- [Cql](README.md)
- [Guides](guides/README.md)
- [Introduction](guides/introduction.md)
- [Installation](guides/installation.md)
- [Core Concepts](guides/coreconcepts/README.md)
- [DB Schema](guides/coreconcepts/schemas.md)
- [Initializing the Database](guides/coreconcepts/initializing-the-database.md)
- [Altering the Schema](guides/coreconcepts/altering-the-schema.md)
- [Migrations](guides/coreconcepts/migrations.md)
- [CRUD Operations](guides/coreconcepts/crud-operations/README.md)
- [Creating Records](guides/coreconcepts/crud-operations/creating-records.md)
- [Reading Records](guides/coreconcepts/crud-operations/reading-records.md)
- [Updating Records](guides/coreconcepts/crud-operations/updating-records.md)
- [Deleting Records](guides/coreconcepts/crud-operations/deleting-records.md)
- [Patterns](guides/coreconcepts/patterns/README.md)
- [Entity Framework](guides/coreconcepts/patterns/entity-framework.md)
- [Active Record](guides/coreconcepts/patterns/active-record/README.md)
- [Records](guides/coreconcepts/patterns/active-record/records.md)
- [Relations](guides/coreconcepts/patterns/active-record/relations.md)
- [Collections](guides/coreconcepts/patterns/active-record/collections.md)
- [Repository](guides/coreconcepts/patterns/repository.md)
- [Cql API](cql/README.md)
- [enum Cql::Adapter](cql/adapter.md)
- [class Cql::AlterTable](cql/altertable.md)
- [class Cql::Column(T)](cql/column.md)
- [class Cql::Delete](cql/delete.md)
- [class Cql::Error](cql/error.md)
- [class Cql::ForeignKey](cql/foreignkey.md)
- [class Cql::Insert](cql/insert.md)
- [class Cql::Migration](cql/migration.md)
- [class Cql::Migrator](cql/migrator.md)
- [class Cql::PrimaryKey(T)](cql/primarykey.md)
- [alias Cql::PrimaryKeyType](cql/primarykeytype.md)
- [class Cql::Query](cql/query.md)
- [module Cql::Record(T, Pk)](cql/record.md)
- [module Cql::Relations](cql/relations.md)
- [class Cql::Repository(T, Pk)](cql/repository.md)
- [class Cql::Schema](cql/schema.md)
- [class Cql::Table](cql/table.md)
- [class Cql::Update](cql/update.md)
- [class Cql::Index](cql/_index.md)
- [Migrator](cql/migrator/README.md)
- [Cql::Migrator::MigrationRecord](cql/migrator/migrationrecord.md)
- [Relations](cql/relations/README.md)
- [module Cql::Relations::BelongsTo](cql/relations/belongsto.md)
- [class Cql::Relations::Collection(Target, Pk)](cql/relations/collection.md)
- [module Cql::Relations::HasMany](cql/relations/hasmany.md)
- [module Cql::Relations::HasOne](cql/relations/hasone.md)
- [class Cql::Relations::ManyCollection(Target, Through, Pk)](cql/relations/manycollection.md)
- [module Cql::Relations::ManyToMany](cql/relations/manytomany.md)
2 changes: 0 additions & 2 deletions docs/cql-1/README.md

This file was deleted.

68 changes: 0 additions & 68 deletions docs/cql-1/_index.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/cql-1/adapter.md

This file was deleted.

172 changes: 0 additions & 172 deletions docs/cql-1/altertable.md

This file was deleted.

Loading

0 comments on commit d80a64c

Please sign in to comment.