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

Reorganiaiton of the docs and updates #427

Open
maliksvd opened this issue Oct 18, 2024 · 1 comment
Open

Reorganiaiton of the docs and updates #427

maliksvd opened this issue Oct 18, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@maliksvd
Copy link

maliksvd commented Oct 18, 2024

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

@maliksvd maliksvd added the enhancement New feature or request label Oct 18, 2024
Copy link
Collaborator

larbish commented Oct 18, 2024

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.

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

No branches or pull requests

2 participants