Closed elliotwaite closed 10 months ago
Visit the deploys page to approve it
Name | Link |
---|---|
Latest commit | f60d540637be34b49e2b0edb32ac8dba0e0ee249 |
The latest updates on your projects. Learn more about Vercel for Git โ๏ธ
Name | Status | Preview | Comments | Updated (UTC) |
---|---|---|---|---|
robyn | โ Ready (Inspect) | Visit Preview | ๐ฌ Add feedback | Oct 16, 2023 8:15pm |
Thank you for the pr @elliotwaite ๐ Your changes look great from the first glance. I will give a thorough review after waking up tomorrow
We are migrating to a new docs website - https://beta.robyn.tech
You can refer to the new docs website till then ๐
Sounds good. Oh, wow. Those new docs look nice. I'll check them out.
Another thing I was going to suggest, although I'm less certain about this one, is that to me, all the h()
functions in the docs seemed odd. Does the "h" stand for "home" or "hello" or something else? Maybe changing them to home()
or hello()
would make them more self-documenting. But that might just be me. Feel free to leave them as the more concise h()
if that's your style.
Another thing I was going to suggest, although I'm less certain about this one, is that to me, all the h() functions in the docs seemed odd. Does the "h" stand for "home" or "hello" or something else? Maybe changing them to home() or hello() would make them more self-documenting. But that might just be me. Feel free to leave them as the more concise h() if that's your style.
Yes, I agree. I mostly use the short notation out of laziness as the function name doesn't really mean a lot with the decorator syntax until you are trying to patch something.
All of these will be fixed in the new docs! I just need to finish this https://github.com/sparckles/Robyn/issues/646 before I complete migration ๐
Comparing elliotwaite:fix-docs
(f60d540) with main
(235fc5d)
โ
106
untouched benchmarks
Here are some suggestions for the docs that I thought of while reading over them. I'm not sure if you'll want to use all of them, so feel cherry-pick the ones you want.
Also, some of the markdown code sections are displaying strangely on these pages:
And this page has a line "export const description = ..." at the top that I'm not sure if it's supposed to be there:
Also, on the docs site, when you click a link in the left nav, it doesnโt scroll to the top of the new page, which is strange when you click a link after having scrolled to the bottom of the previous page.