@payload/ui needs documentation

[ckruppe]

The problem: As i make many customisations to the admin backend (adding new fields, views and so on) i find it hard to find the right components from payload that are already there. Its also particularily hard to find out how they work. I have to dig into the repository all the time especially if my goal is that these custom changes integrate seamless in the UI of the existing admin.

The solution:
I would love to see an separate documentation of the the @payload/ui package or even an storybook with autodocs. This would help build custom features for the admin faster and easyier.

It would also boost creation of plugins i suppose as easier implementation brings mote people to actual building new stuff for the payload admin.

[matthijs166]

I agree!
Something like this would be awesome: https://ui.shadcn.com/docs/components/badge

[marpstar]

A lot of the individual components (inputs, buttons, etc) aren't too difficult to figure out but things like Table are much less straight-forward. I see the team is still shifting a lot of things between the payload and @payloadcms/ui packages, even as recently as this week, so I'm hoping that they're working to solidify the API in preparation of documenting things.

Pulling in other UI libraries feels wrong but is infinitely easier to do at the moment than pull in anything from @payloadcms/ui.

[michaelshowes]

For a platform that prides itself on customizability, it's definitely a chore to find some of these features and components. You'd think clear documentation would be a top priority. Unfortunately, to figure out some things to you have to reverse engineer existing code or ask in the discord.

[matthijs166]

Maybe we can start a PR to extend the docs on this topic. Where is the best place to start?