Skip to content

Improve the e-mail authentication documentation #511

@Swiftaxe

Description

@Swiftaxe

Goal

Improve the e-mail authentication docs to make it easier to follow. Part of #503.


Tasks


  • Fact-check against the latest Serverpod version.
  • Rewrite the setup guide to be explicit, unambiguous, and ensure all steps are documented.
  • Add clear and complete examples for client-side and server-side implementations.
  • Rename the existing "Configurations" page to "Customizations" for clarity.
  • Move advanced use cases to the "Customizations" page to keep the primary guide focused.
  • Add a "Publishing to production" section that details specific steps for production.
  • Create a "Troubleshooting" page that lists common errors, their causes, and solutions.


Definition of done

  • A developer can follow the guide from start to finish and successfully get it working locally and on Serverpod Cloud.
  • The process is easy to complete without requiring extra research.
  • Every step is clearly documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions