Xyphyn / photon

A replacement for lemmy-ui with more features, a better design, and more customizability.
https://phtn.app
GNU Affero General Public License v3.0
311 stars 35 forks source link

docs: Post component comments #354

Closed sevonj closed 1 week ago

sevonj commented 1 week ago

This is comments / documentation only, no actual code has been changed.

As a new contributor it was somewhat tedious to figure out what the components do. Their purposes and relationships aren't always straightforward. Often the same component is responsible for multiple distinct jobs. I added a couple @component-annotated doc comments on things that weren't immediately obvious to me.

Maybe some of the quirks could be refactored out, too.

vercel[bot] commented 1 week ago

@sevonj is attempting to deploy a commit to the Xylight's projects Team on Vercel.

A member of the Team first needs to authorize it.

Xyphyn commented 1 week ago

I'll add docs to components myself, but thanks for reminding me to do so!