selfrefactor / rambda

Faster and smaller alternative to Ramda
https://selfrefactor.github.io/rambda
MIT License
1.65k stars 89 forks source link

Doc issues #637

Closed HaveF closed 2 years ago

HaveF commented 2 years ago

@selfrefactor I like your rambda ❤️

I'm not very familiar with FP, so when I use rambda, I often look the Doc for help. But the doc is a bit hard to search. Normally, I want a function for list, I will go to ramdajs 😂 and use list to narrow down the scope, then find what I'm looking for.

image

For example, I find the without function, then went to https://selfrefactor.github.io/rambda/ to search without(because rambda has a little different with ramda)

image

Then I click 💥

image

It seems like something url parse problem. Even without this bug, the doc is still hard to read.

Frankly speaking, I do suppose your tool is over underestimate because Doc.

Btw, after some research, I think https://docusaurus.io/ maybe fine for the Doc.

Do you have any idea or plan about the doc?

selfrefactor commented 2 years ago

Thanks for the issue report.

I will look into it during the weekend and get back to you. As for using Docusaurus - I am developing Angular application as Rambda documentation site, but I will look into it to see if I can easily use it.

HaveF commented 2 years ago

Build Angular App as documentation site is great, though it needs time to maintain and introduce new features.

Some other options for you to choose:

It seems docusaurus grows faster.

image

If you want me to do some doc work, let me know!

selfrefactor commented 2 years ago

thanks for all the recommendations; will take a look at it later and get back to you.

selfrefactor commented 2 years ago

fyi, the documentation site is build with docsify. Also, I am unable to reproduce the issue. I search with the browser for without then I click on the sidebar link and it correctly redirects me. Can you share more info how I can reproduce it?

HaveF commented 2 years ago

Oh, that's strange...

After I tried in another browser it is fine. Then I suspect the web extension which I installed...

Finally, I find ClearURLs 1.24.1 break the page. When I open url https://selfrefactor.github.io/rambda/, it will change the url to https://selfrefactor.github.io/rambda/#%2F=, after that, all link in the page broken...

Of course, the extension broken https://docsify.js.org/ page too = =;

selfrefactor commented 2 years ago

Thanks for resolving it. I will still try docusaurus to see if it could replace docsify.

HaveF commented 2 years ago

Ok, If you want me to do some doc work, let me know!

HaveF commented 2 years ago

For somebody who stumbled with this issue(use ClearURLs 1.24.1), see this solution. It works now.