sanctuary-js / sanctuary-site Goto Github PK

I keep getting the an email with the following from GitHub. Seems like it should be a straightforward upgrade.

It would be nice to have something similar to http://ramdajs.com/repl/ at https://sanctuary.js.org/repl/.

Thanks for suggesting this in the Gitter room, @Rafi993. :)

At the moment, it's a bit of a mishmash keeping tabs on the docs between sanctuary,sanctuary-def and sanctuary-type-classes. It would be nice if we could bring the docs for these projects into the site.

One way we could do this is by adding a new "button bar" element fixed to the top right that could be used to toggle between the library docs. We could also put other things like the search from #11 next to it to have it look sort of like:

One thing to consider will be how to handle doclinks. We could build out each repo as it's own static page and just link them together like that, or we can be a bit fancy using javascript and have prefixs for url hashes so that you could link to Z.map with https://sanctuary.js.org/#Z.map.

It would be nice if the docs used the logo as a favicon so I could find the tab after using chrome for little while.

Assuming this is all fine, I can make a PR for this.

Hi there,

Just came across sanctuary and while reading the doc, suddenly Z.toString then Z.equals starting popping up but there's no definition of what Z is.

What is Z? And could you introduce it in the docs?

Thanks!

Jun

@foxdonut, on Gitter:

Wait, you can type into the code examples of https://sanctuary.js.org and see the results?! :mindblown:

Let's find an unobtrusive way to draw attention to this feature. One option is to display a dismissable banner to inform the reader about the feature. When the banner is dismissed we could save a cookie or add an entry to local storage so the reader will not see the banner again.

/cc @RomanValihura, @JAForbes, @laduke

Submit js-org/js.org@master...davidchambers:sanctuary with title 'sanctuary.js.org'.

I found a gotcha when using sanctuary and vite, that makes sanctuary about a hundred times slower ;)

According to vite - Env Variables and sanctuary - Type checking, it looks like you automatically disable type checking when you create a vite build using npm run build. But due to the way that vite substitute process.env.NODE_ENV with either development or production and how sanctuary is detecting process.env.NODE_ENV, you will not disable type checking!

The work-around is:

import sanctuary from 'sanctuary';
const S = sanctuary.create ({ checkTypes: import.meta.env.DEV, env: sanctuary.env });

You can not currently set process.env.NODE_ENV manually in vite. As of writing, vite is version 2.9.6.

I wanted to create a PR for this to update the type-checking or installation section but checking that it looks good is a little more involved than I have time for currently. So this is serve as a reminder :)

Now that this is possible - would be nice to have the section in the docs describing def usage be live-editable.

Specifically, the section after "the following snippet demonstrates defining a custom type"

Since we don't control the server we can't perform 301 redirections, but we can at least use JavaScript to perform client-side redirections.

I plan to submit a pull request this evening for this change.

It's kind of hard to find functions. Should we add a real simple table of contents?

Hello,

I am really enjoying sanctuary, but the documentation is being very hard to navigate.
The main reason is because I have to scroll up and down all the time. I have to go to the top of the page to see the index, look for what I'm looking for and then click on the reference. This happens hundreds of times on a single day, and it's being exhausting. Specially when you are just starting.
On this regard ramda (and lodash) has made a terrific job on making the functions accesible. It's very easy and pleasant to navigate the documentation. Could something like this be added to sanctuary docs ?

Thanks in advance and keep up the good work.