nuqs icon indicating copy to clipboard operation
nuqs copied to clipboard

Add community adapters section to documentation

Open Joehoel opened this issue 1 year ago • 5 comments

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

Joehoel avatar Nov 28 '24 18:11 Joehoel

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

A member of the Team first needs to authorize it.

vercel[bot] avatar Nov 28 '24 18:11 vercel[bot]

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

vercel[bot] avatar Nov 28 '24 20:11 vercel[bot]

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).

franky47 avatar Nov 28 '24 20:11 franky47

Maybe a section like this?

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

Joehoel avatar Nov 28 '24 20:11 Joehoel

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 avatar Nov 28 '24 20:11 franky47