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

Fix README.md MAILER_TEMPLATES_RECOVERY default. #1230

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

2start
Copy link

@2start 2start commented Aug 22, 2023

I copied the actual template from the code and pasted it into the docs.

A general comment: Setting up supabase auth standalone was an improvable experience. A lot of small issues on the way. There are a lot of small things undocumented e.g. there exists an createUser endpoint which is not in the API spec or in the readme or some env variables are just not properly documented or have small mistakes. It feels like the docs are a 1:1 copy from netlify/gotrue without any improvement. I know this is not your main business objective to improve the standalone experience but would be awesome if you try to keep the docs up to date with your changes.

@2start 2start requested a review from a team as a code owner August 22, 2023 16:20
@J0
Copy link
Contributor

J0 commented Aug 29, 2023

Hey @2start,

Thanks for the contribution and for waiting patiently for a review!

there exists an createUser endpoint which is not in the API spec or in the readme or some env variables are just not properly documented or have small mistakes.

These are good points - agree that we should document any missing methods and any mistakes in the API- do you mind pointing me to the relevant method(s)? We do sometimes miss things - couldn't quite find the createUser method in particular so if you could highlight that would be helpful!

It feels like the docs are a 1:1 copy from netlify/gotrue without any improvement. I know this is not your main business objective to improve the standalone experience but would be awesome if you try to keep the docs up to date with your changes.

Aware that it can be frustrating when the docs don't align. We'll try to do better.

With respect to this PR MAILER_TEMPLATES_RECOVERY I think the content is intended to be:

<h2>Reset Password</h2>
<p>Follow this link to reset the password for your user:</p>
<p><a href="{{ .ConfirmationURL }}">Reset Password</a></p>

It might be the case that the defaults are actually wrong. Do you recall where you found the template? Can update it if you can point me to the source.

Once again, thanks for taking the time to improve Supabase Auth!

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

Successfully merging this pull request may close these issues.

2 participants