search

nuxt-modules / supabase

Supabase module for Nuxt.
https://supabase.nuxtjs.org
MIT License
698 stars 126 forks source link

Reorganiaiton of the docs and updates #427

Open maliksvd opened 1 week ago

maliksvd commented 1 week ago

Is your feature request related to a problem? Please describe.

Currently, the documentation for the Supabase Nuxt module lacks a clear structure, making it difficult for new users to navigate and understand. This can be frustrating, especially for developers who are not familiar with the module and are looking for quick and straightforward instructions, as I experienced myself when I first started.

Describe the solution you'd like

I propose reorganizing the documentation to make it more user-friendly and easier to follow. This would include adding clear sections for installation, configuration, and usage, as well as detailed examples for common use cases.

What I propose:

  1. Introduction

  2. Get Started

    • Installation
    • Configuration

  3. Authentication

    • Email & Password
    • OTP (One Time Password)
    • OAuth
    • Session Management
    • Reset Password

  4. Composables

    • useSupabaseClient
    • useSupabaseAuth
    • useSupabaseStorage

  5. Server

    • serverSupabaseClient
    • serverSupabaseServiceRole
    • serverSupabaseSession
    • serverSupabaseUser

  6. Changelog

  7. Roadmap

Additional context

I have already forked the repository and started reorganizing the documentation.

You can find my progress here: https://github.com/maliksvd/supabase/tree/main/docs/content

larbish commented 1 week ago

Hey @maliksvd, that's a great initiative. Just so you know I was thinking of rebuild the all docs with Nuxt Content v3 and Nuxt UIPro v3. But there are both in alpha for the moment. What do you think about waiting for more stable releases ? You can already work on the structure however.