docs: Document the database schema relations for Message - #208
Open
Daksh7785 wants to merge 3 commits into
Open
Conversation
|
Someone is attempting to deploy a commit to the Dharm3112's projects Team on Vercel. A member of the Team first needs to authorize it. |
👷 Deploy request for intellicircle pending review.Visit the deploys page to approve it
|
This file contains hidden or 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
1 participant
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.
What does this PR do?
This Pull Request introduces a new documentation file
docs/database-schema-message.mdthat fully documents the relationships, columns, indexes, and structure of themessagestable according to our Drizzle ORM schema.Why is this necessary?
As per Issue #15, having clear documentation on core database tables drastically reduces the onboarding time for new contributors. Specifically, it highlights the
roomIdanduserIdforeign keys, and details the composite index (roomHistoryIdx) used for optimizing room history queries.How was this verified?
packages/shared/src/schema.tsfile to ensure 100% accuracy in the documentation.Thank you for reviewing my PR! Let me know if any changes are required, I am happy to accept constructive feedback as per our community Code of Conduct.