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

Add community adapters section to documentation #788

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

Joehoel
Copy link

@Joehoel Joehoel commented Nov 28, 2024

Related to #787. It would be nice to have a section to find the community adapters in the sidebar.

2024-11-28 at 19 36 58@2x

Copy link

vercel bot commented Nov 28, 2024

@Joehoel is attempting to deploy a commit to the 47ng Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Nov 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nuqs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 28, 2024 8:05pm

@franky47
Copy link
Member

I wonder if we should move the community adapters & parsers into their own section, maybe at some point we could also share community recipes (parser definitions + custom hooks, à la shadcn/ui).

@Joehoel
Copy link
Author

Joehoel commented Nov 28, 2024

Maybe a section like this?

- Adapters
  - Built in
  - Community
- Parsers
  - ...

@franky47
Copy link
Member

franky47 commented Nov 28, 2024

That could work too. I was thinking more like:

** Getting started **
- Installation
- Adapters
- Basic usage

** Guides **
...

** Going further **
...

** Community **
- Adapters
  - Inertia
  - One
- Parsers
  - Date & Time
  - Map & Set
  - Compound parsers
  - TanStack Table

The idea with the "Getting started" section is to keep it as lean as possible, to avoid losing newcomers with a ton of options. The official adapters are likely the most used, and so for other folks it'd be a little indirection through the community section and back to the docs.

@franky47 franky47 added the documentation Improvements or additions to documentation label Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants