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 API docs and add them to this repository #23

Open
jkleiber opened this issue Apr 17, 2024 · 1 comment
Open

Create API docs and add them to this repository #23

jkleiber opened this issue Apr 17, 2024 · 1 comment

Comments

@jkleiber
Copy link
Owner

Summary
Supabase auto creates documentation for interacting with the database. For ease of use by other developers, these docs should be linked to this repo via the README or some other means.

@jkleiber jkleiber self-assigned this Apr 17, 2024
@jkleiber jkleiber added this to the Minimum Viable Product milestone Apr 24, 2024
@jkleiber jkleiber changed the title Link the database API docs to this repository Create API docs and add them to this repository May 16, 2024
@jkleiber
Copy link
Owner Author

While this information is still somewhat unclear, typescript types have been added for the database schema and will be maintained as best as possible. Remaining work in this issue is to integrate the typescript type generation into CI somehow so this can be kept updated. Eventually we will probably want to switch to typescript, but that's far enough out to not make it a ticket.

This is no longer MVP but still highly desirable. Moving off the milestone

@jkleiber jkleiber removed this from the Minimum Viable Product milestone May 29, 2024
@jkleiber jkleiber added this to the Documentation Improvements milestone Jun 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant