Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create markdown documentation for database schemas #74

Open
jts599 opened this issue Dec 8, 2023 · 0 comments
Open

Create markdown documentation for database schemas #74

jts599 opened this issue Dec 8, 2023 · 0 comments

Comments

@jts599
Copy link

jts599 commented Dec 8, 2023

Is your feature request related to a problem? Please describe.
Currently, the database schemas are only documented in code.

Describe the solution you'd like
Create a markdown page with a more human readable representation of the database structure

Describe alternatives you've considered
There are other more human readable formats that could be used, but Github markdown seems to be a natural fit.

Additional context
I have a script that generates an (admittedly basic) markdown page for the schemas in my fork's transform/src/schemas directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant