Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor documentation to be more independent and catchy #725

Open
arnfaldur opened this issue Sep 12, 2023 · 0 comments
Open

Refactor documentation to be more independent and catchy #725

arnfaldur opened this issue Sep 12, 2023 · 0 comments

Comments

@arnfaldur
Copy link

The API reference includes a large amount of comparison to Ramda, especially in the beginning.

Most of it is not relevant to users discovering the project.
I suggest moving the detailed comparison to a dedicated section that can be linked to in the beginning for potential Ramda converts.

I also think the README.md could sell the library better. Making the first few paragraphs of the README.md snazzier could be an improvement.

I can do this if there is interest.

@arnfaldur arnfaldur changed the title Refactor documentation to be more independent Refactor documentation to be more independent and catchy Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant