sossoldi icon indicating copy to clipboard operation
sossoldi copied to clipboard

Published 20 hours ago • verified publisher icon RIP-Comm

Database documentation

Open gioisco opened this issue 6 months ago • 0 comments

Description

I have created new documentation for the database schema as part of the efforts to address issue #123. This documentation is based on draft PR #167 and provides detailed descriptions of each table, its fields, and their relationships, which will aid in better understanding and maintaining the database.

Doubts

  1. Why are Foreign Keys not used? Foreign keys are a best practice for maintaining referential integrity and clarifying relationships between tables.

  2. Noted Concerns: There are some unusual constraints, naming conventions, and fields that might need to be removed. I have left notes with my concerns in the database-structure-doc.md. If these concerns are only my own, they can be ignored, or we can consider modifying the database. Please let me know how you would like to proceed.

Why this PR is a draft

  • [ ] Addressing the concerns mentioned in point 2.

  • [ ] I am currently unable to see the same template in my GitHub Pages as in the RIP-Comm repo. I need to investigate further to ensure the new pages display correctly.

  • [ ] I have not yet tested how to render the database-schema-mermaid.mermaid in GitHub Pages. I will explore the best solution.

Related Issue

This PR will close issue #123, following the merge of PR #167.

gioisco avatar Aug 19 '24 00:08 gioisco