As a developer, I want to create

• the documentation of the database model used for this project by using DBML

• the creation of a document that describes the tables and each of the fields of each table as well as their relationships and their indexes

Create both themes, the light and the dark theme

As a development team,

I want to establish and adhere to a service-repository design pattern,

So that we can ensure a clear delineation between the layers that interact with data models and those that implement business rules, enhancing the project's maintainability and adherence to clean code practices.

Acceptance Criteria

1. Given the project's existing codebase,
   When we implement the new features or refactor existing ones,
   Then the code should clearly separate data access logic in repository layers from business logic in service layers.

2. Given a new or existing feature,
   When it interacts with the data model,
   Then it must do so through a repository layer that abstracts the details of data access.

3. Given a feature that implements business rules,
   When it is developed or refactored,
   Then it must reside in a service layer that interacts with repositories to affect data without being coupled to the data access mechanisms.

4. Given the implementation of the service-repository model,
   When reviewing the project's code,
   Then there should be evidence of improved maintainability, such as easier code navigation, simpler unit testing due to decoupled logic, and adherence to clean code practices.

As a database documentation reader,

I want to have an index at the beginning of the documentation,

So that I can easily navigate to different sections of the document directly from the index.

Acceptance Criteria:

• Given I am viewing the database documentation on GitHub,

• When I look at the beginning of the document,

• Then I should see an index listing all the main sections of the documentation.

• Given I am viewing the index in the database documentation,

• When I click on a link in the index,

• Then the document should navigate to the corresponding section in the Markdown file.