search

solidjs / solid-start

SolidStart, the Solid app framework
https://start.solidjs.com
MIT License
5.05k stars 377 forks source link

Typescript docs for hooks and components #442

Open joepio opened 1 year ago

joepio commented 1 year ago

I really like the workflow of this promising framework, but the lack of documentation for practically all exported items of both Solid-Start as well as SolidJS makes feature discovery and API understanding harder than it needs to be. Is this a deliberate decision or just a lack of contributions / difference in prioritization?

If you need help with this, I'm pretty sure some people (like me) are willing to write some documentation for components.

One challenge is to keep the inline JS docs in sync with the website. For example, the useNavigate hook should have documentation on the website as well as in the code.

Tools like tsdoc may help to generate documentation pages from ts comments, keeping both in sync.

ryansolid commented 6 months ago

Is this a deliberate decision or just a lack of contributions / difference in prioritization?

Not a deliberate decision just a matter of contribution and prioritization. We always can use more help in this area.