solid-router icon indicating copy to clipboard operation
solid-router copied to clipboard

Published 20 hours ago • verified publisher icon solidjs

About documentation

Open m4rocks opened this issue 3 years ago • 2 comments

The documentation on this package is pretty bad. I mean I saw a lot of functions I could make use of, but I don't understand their code, and they are not documented. I saw almost no comments in the entire code. I would be glad to help with the documentation, but I would need some time and a starting point.

Also a question I have. How in the world do you go back to previous route? Am I forced to pass state on each route change?

m4rocks avatar May 19 '22 12:05 m4rocks

+1

I had to go through the code to know that NavLink has prop called end

SalemCode8 avatar May 24 '22 12:05 SalemCode8

This is a fair question and something we need to do better. Eventually taking it to a documentation site probably. PRs for docs improvements are always welcome. Right now it's just a Readme but we can build it out from there to a few md files and then a site as needed.

ryansolid avatar Nov 21 '22 20:11 ryansolid