chore(docs): db doc #606
Merged
chore(docs): db doc #606
Conversation
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
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.
This pull request adds comprehensive documentation for the database schema used in the project. The new documentation describes the structure, purpose, and example data for all key collections and tables in both the
hawkandhawk_eventsdatabases.Database schema documentation:
Added an overview of the two main databases:
hawk_events(for storing events) andhawk(for storing account, workspace, and project data).Documented the structure and fields for the following collections in the
hawkdatabase:users,workspaces,projects, andteam:<workspaceId>, including field descriptions and example values.Documented the structure and fields for the following collections in the
hawk_eventsdatabase:events:<projectId>,repetitions:<projectId>,dailyEvents:<projectId>, andreleases, with detailed tables for each.Included example data rows and links to additional resources for event payloads and releases.