ramda/ramda.github.io

:ram: :globe_with_meridians: Documentation for Ramda.js

ramda.github.io's Issues

offline support

thanks for great lib

i frequently developing offline so i’m using readme in node_modules as API docs, but ramda doesnt have it. it makes me kinda sad

also one of solution is to add offline support to ramda docs

Repl Reset Button Does Nothing

Suggested behavior: window.location = '/repl/'

cdnjs link is broken

The cdnjs link is as of version 0.21.0 broken: <script src="//cdnjs.cloudflare.com/ajax/libs/ramda/ramda.min.js"/"ramda.min.js"/"ramda.min.js"/"0.21/ramda.min.js"/ramda.min.js".1/ramda.min.js"/ramda.min.js"></script>.

AFAICT it should rather be <script src="//cdnjs.cloudflare.com/ajax/libs/ramda/0.21.0/ramda.min.js"></script>.

Mobile Menu Stuck open on IOS Safari and Glitch in Chrome between 750px and 770px

Reading Rambda Docs on my iphone in safari and discovered on the home page menu is stuck open and glitches on desktop in chrome between 750px and 770px. Would like to look into it further and submit a PR. I have a feeling something is not being loaded or glitching on transition between desktop view and mobile.

Thank you

Try Ramda should use uncompressed version of ramda

e.g.
function (r){return function(e){return Pr(function(n){return t(n,e)},r(n(e)))}} is hard to decipher when your code isn't working.

Browser back button does not work properly in docs

Example:

1. Visit http://ramdajs.com/0.18.0/docs/
2. Under add it says "See also subtract", so click that.
3. Click the browser back button.

Expected result: the page jumps back to add.
Actual result: The URL changes, but the page does not scroll.

I assume this is the result of some JavaScript controlling the links, though a cursory poke through the source doesn't reveal anything obvious.

Documentation: Visual bug -- overflow <li> bounding box when name is too long

behavior is consistent at smaller & larger zoom levels in chrome

REPL doesn't respect `code` query parameter anymore

@kujon observed:

Refreshing the page clears it.

Chrome 52.0.2743.116 (64-bit)
OS X 10.11.6

@ codemirror.min.js:1 Uncaught TypeError: Cannot read property 'split' of undefinedH.splitLines
@ codemirror.min.js:1splitLines
@ codemirror.min.js:1(anonymous function)
@ codemirror.min.js:1(anonymous function)
@ codemirror.min.js:1(anonymous function)
@ codemirror.min.js:14../googl
@ bundle.js:251s
@ bundle.js:1e
@ bundle.js:1(anonymous function)
@ bundle.js:1

Totally messed up on mobile

Not sure whether it's meant to be viewed on mobile, but it's totally unusable ATM.

This is on iOS 8.1.3.

Add category filter to docs

copied from ramda/ramda#713

"I think we should go with a dropdown and see what people think of that." -- @saikobee

No momentum scrolling `.docs-page main` and `.sidebar .toc` (iOS)

Small bug

In the "try ramda" under examples and useWith the sum function uses foldl instead of reduce

Evolve example a bit misleading

Hi,

So if you go to evolve the sample shows that if you add a data key to the transformer it will nest elapsed and remaining inside like so:

//=> {firstName: 'Tomato', data: {elapsed: 101, remaining: 1399}}

However if you try it out the results are as followed:

var tomato  = {firstName: '  Tomato ', elapsed: 100, remaining: 1400};
var transformations = {
  firstName: R.trim,
  lastName: R.trim,
  data: {elapsed: R.add(1), remaining: R.add(-1)}
};
R.evolve(transformations, tomato);

//=> {"elapsed": 100, "firstName": "Tomato", "remaining": 1400}

with no data key in sight 😦

cheers david

Multiple types are not shown in "expand parameters" in documentation

When there are several possible types for a parameter, only the first one is shown when clicking "expand parameters" in the documentation. For example for "pluck" in the code we have @param {Number|String} key . However only Number is display in the expand parameter box.

(Moved from ramda/ramda#1718. @jagare)

"TRY in repl" does not open in new tab

This is quite cumbersome because the user has to leave the current page everytime he/she wants to tryout a function. Can it be converted into an anchor tag instead?

PS: can we not have the function run in the documentation page itself, and then have a different link to share that piece of code via a link instead of try in REPL

Move fonts and styles out of version folders

It seems unnecessary to have the same files in each of the version folders.

Would there be any problems with moving the font files and style.css into a common folder?

This would simplify the make process too.

expose documentation for previous releases

copied from ramda/ramda#821

Replace Makefile with cross-platform scripts

It would be nice to replace the Makefile with something that works on Windows and others.

I'm happy to do the work, but I just need to confirm what functionality is needed.

From what I can pick out:

• Build /index.html, with redirect to latest version of docs.
• Download specific version of Ramda.
• Run GitBook on specific version of Ramda.
• Run JSDoc on specific version of Ramda.
• Run Less compiler.

Please let me know anything I'm missing?

Mistake in `takeLast` example

The second line in takeLast examples is incorrect:

R.takeLast(2, ['foo', 'bar', 'baz']); //=> ['for', 'baz']

According to the function description, the output should be ['bar', 'baz']

Move manual pages into own folders

Would there be any issue with moving each of the manual pages into their own folder, with the content stored in a README.md in each?
This would allow an index.html to be generated from each README.md and sit beside it for serving to the web.

For example, in manual/01-intro, Composition.md would be moved/renamed to Composition/README.md.

Take out bootstrap?

Fantastic documentation site! Like really! 💯 We are using a fork of this for our own internal projects!

One thing we encountered was that style.css has bootstrap mixed into it! Maybe including a themed (or non - themed) bootstrap.css (or bootstrap.less) outside would be better? As bootstrap upgrades, the documentation site gets those updates for free?

I'd be happy to submit a PR of the core team is interested :)

Split manual into separate repo

As was done for the REPL, and considering work on it has stalled, would it be worthwhile moving the manual into a separate repo?

This would also allow removing the gitbook dependency.

Search by type signature

Would it be possible to incorporate type signature search in the current search bar. Something resembling Hoogle like functionality.

I would really like to be able to search for (a → b) → f a → f b and get map.

Missing hamburger icon on IE Mobile, Firefox for Android and Firefox

Styles for printing

I just stumbled upon this library and it looks really awesome! Unfortunately reading whole documentation on the screen is pretty hard (at least for me). I tried to print it, but it seems that print styles are really messed up.

So I got this small, humble request: please fix them, it will be very helpful to make printing possible (especially for beginners).

Difference should link to symmetricDifference, and vice-versa.

In the documentation for difference, there's a "See also differenceWith", but it should be "See also differenceWith, symmetricDifference."

Likewise, for differenceWith, symmetricDifference and symmetricDifferenceWith.

package.json

Hello!

I've noticed that there are two package.json files - one at /package.json and another at /repl/package.json.

I propose that this be reduced to 1 for the following reasons:

• all the npm run * commands can be found within one place.
• we reduce the number of duplicate packages that need to be downloaded (if there are any).

Furthermore I suggest that the npm-shrinkwrap.json (present in /repl, not in /) be moved to / and updated accordingly.

I'd be very happy to make these changes and update the npm scripts etc, if this proposal is accepted.

mysterious REPL behaviour when using lens named "name"

This works as expected:

var _name = R.lensProp('name');

R.view(_name, {name: 42});

This, on the other hand, does not:

var name = R.lensProp('name');

R.view(name, {name: 42});

Perhaps the object to which a property is being assigned has a read-only name property?

FR: Auto complete in web REPL

Auto complete or tab complete on R.

Make docs a todo list applicaiton

Might seem kind of dumb but I keep my own separate spreadsheet where I mark off Ramda functions as I use them. It helps me track my progress, I really don't see any other way to learn a library like this.

It would be nice If I in the docs I could check off functions that I'm familiar with and then filter the docs by used / unknown functions.

FR: Switch to Babel on web REPL.

^

Small UX issue: clicking the "input" area in the REPL doesn't always bring focus to the text input

If the Input text area loses focus, clicking anywhere in the input column doesn't bring focus back to the text input; you must instead click inside where a current line of code is.

Below is the div that I think is capturing the click.
Current:

This used to work before #83, you can view the old behavior by checking out commit fb0cbc0

Old:

I'm assuming this is from changing

.CodeMirror {
    height: 500px;
}

to

.CodeMirror {
    height: 100%;
}

in https://github.com/ramda/ramda.github.io/blob/master/repl/lib/css/terminal.css

I'm happy to poke at this a bit later and submit a PR, but I am by no means a CSS expert, so no promises 😆

Content overflows viewport on x-axis on mobile

Make a second on the website for common formulas

From @krainboltgreene on April 20, 2016 22:0

Hey! Long time (4 months) lover of ramda.js, and I find myself with a fun little function that I don't think should be added to ramda but should be available to others if they need the same thing.

So as I propose a new tab on the website for function frankensteins that are too easy to be added to ramda, but too small for a library. "Examples" or "Practical" or "Recipies"?

Thoughts?

Copied from original issue: ramda/ramda#1744

docs generated? Or made by hand?

If generated, what do you use?

Add Gitter room for this repo (docs/website)

Would anyone be interested in a Gitter room for this repo?

I'm thinking it could be useful to separate docs/website chat from general chat.

rename repository

In my view ramda-site would be a nicer name for this repository. Do we need to stick with ramda.github.io in order for the GitHub Pages wiring to work?

change docs from redirect to copy

@raine points out:

"since people will be linking to urls that are hardcoded to specific version, people might end up reading old docs without realizing it"

i think the solution is to cp -Rp /$VERSION/docs/* /docs instead of the redirect. Any objections?

Documentation for eqDeep is missing

Tapping status bar on docs page doesn’t scroll to top (iOS)

Responsive Design - A pragmatic solution

Problem

The current website doesn't scale, mainly because the leftmost column has a fixed width. I have seen the long term solution on ramda/ramda#1000, but I'd like to opt for a quick solution as well, since a complete redesign/recode of the frontend might take a while :)

This is what it looks like on a fairly big phone resolution (screenshot scaled down by 50%):

The homepage does a better job, but still not all the content is reachable, which is most important for your users of course.

Pragmatic solution

Currently, the <aside> has a fixed width of 250px, and the <main> a left: 250px;. What if we made the sidebar optional for smaller screens? It's easy to make a hamburger menu (or a simple 'open menu' link if you hate hamburgers) and close the sidebar by default. This can be done through some trickery with a css-only solution, which is always preferable.

I've made a quick proof of concept for how this could work: http://codepen.io/branneman/pen/BNvNQB/left/?editors=110 (resize the viewport to see it in action)
Again, I've not touched the bigger screen design (tablets, desktop, etc.), I only hid the sidebar for smaller screens and added a way to open/close that sidebar.

This should be, together with an optimised <header> for smaller screens, enough to give mobile users a way better experience than they currently have.

Thoughts?

Consider use of js.org for hosting

I've noticed a few projects using js.org for hosting documentation.
Is there any interest in setting up ramda.js.org?

The DNS page and GitHub repo have instructions on how to set it up.
From my brief look, it just involves adding an entry to a file in their repo.

Maybe this could be used for the manual?

Docs "See also" link issue

http://ramdajs.com/docs/#reduce
http://ramdajs.com/docs/#map

R.construct example uses an arrow function as constructor

Hi,

the example for R.construct uses the Widget arrow function as a constructor function. However, my understanding is that arrow functions cannot be used as constructors because of lexical binding (see, e.g., here and here).

ciao!

Proposal: Add link to gitter room in top nav

^^^ any interest in this?

Remove redirect from home page

This might be controversial, but I'll give my reasoning for removing the home page redirect:

• You can bookmark a link that will always show the latest version.
• It makes building index.html easier (don't have to build into a version folder).

The latter idea was actually merged in #93, but that doesn't mean it can't be updated if this idea is not acceptable.

Remove manual from version folders

Considering the manual is not based on the version of Ramda, should it be removed from each of the version folders?

I'm also thinking that since it hasn't been linked from pages yet that it could be removed without breaking links.

Just to be clear, I'm not talking about removing the manual folder from the root of the repo.

make repl style consistent with the rest of the site

more examples

Missing font files

The symptom is square boxes on the page.