Database documentation #174
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Why are Foreign Keys not used? Foreign keys are a best practice for maintaining referential integrity and clarifying relationships between tables.
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.mermaidin GitHub Pages. I will explore the best solution.Related Issue
This PR will close issue #123, following the merge of PR #167.