-
Notifications
You must be signed in to change notification settings - Fork 51
Description
Is this related to an existing part of the documentation?
- Yes, it is related to an existing section
What needs to be updated?
Current Documentation Issue
The current backend documentation does not clearly define the Supabase database schema used by the application. While SQL migration files exist in the repository, there is no centralized or human-readable documentation describing:
Which tables are used by the app
The purpose of each table
The fields/columns within those tables
Relationships between tables
As a result, contributors attempting to work on features such as profile editing, user preferences, or settings face difficulty understanding which tables to query or update, slowing down development and increasing onboarding time.
Proposed Changes
Add a dedicated Database Schema Documentation section that clearly explains the Supabase tables used in the project.
Suggested additions include:
A table-by-table breakdown listing:
Table name
Column names
Data types
Purpose of each field
High-level explanation of relationships between tables (e.g. users → teams → tasks)
Optional ER diagram or schema overview generated from Supabase
Clear indication of which tables are:
Read-only (e.g. auth.users)
Meant to be accessed/updated by the frontend (e.g. public.users, preferences tables)
This documentation can live in:
The backend setup guide, or
A separate DATABASE_SCHEMA.md file in the repository
Additional Context
Contributors currently need to manually inspect SQL migration files or the Supabase dashboard to understand the schema
This creates friction when implementing common features such as:
Editing user profiles
Managing preferences (e.g. language selection)
Extending existing backend functionality
Clear schema documentation would significantly improve contributor experience and reduce duplicated effort
Impact
Faster onboarding for new contributors
Fewer backend-related blockers
Clearer separation of responsibilities between frontend and backend
Improved maintainability of the project
Relevant Documentation Link (if any)
No response
Record
- I agree to follow this project's Code of Conduct
- I want to work on this update