-
Notifications
You must be signed in to change notification settings - Fork 41
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
Add recipes #262
Comments
Also, to anyone else who may see this, please feel free to add suggestions! I just brainstormed this list off the top of my head in a few minutes, so I probably missed a lot of things. |
@mlms13 I can definitely help with this. Is there a particular place where you are thinking these should live? |
Seems like there are two options:
|
I think option 1 is the best way to get started. It can always get moved out later if the other things become a necessity |
Just to throw it out there, you can put stuff in the docs/ folder, and link to it using the docsify.js stuff that we have now. Michael just deleted a bunch of the API-level stuff in favor of the odoc, but you can add new markdown files in there for recipes. Or you could just add tests to the project that demonstrate some of the recipes. That way they will be compiled and tested along with everything else. |
Cool, sold. Once I merge the odoc PR (hopefully today!) which changes the docs folder a bit, we can create I'm hoping to have a centralized place to show off recipes for e.g. |
@mlms13 You asked me to drop things here that require documentation/recipes. But I had to find that out by trying to find out via the github issues why it broke my build (shadows Js, so that |
I was just working on writing the api docs for the |
I also had quite a lengthy discussion on Discord today about performance and api design. I always like if docs are explicit about complexity of operations. Especially as a beginner it is a way to understand the implementation a bit better. |
Yeah, I've loved that the Purescript docs are very clear which functions on collections are |
@mlms13 what's the best way to move this forward? Should I just create that directory in |
I think that would be fine as a starting point - you can link to those from the sidebar markdown file. |
I was looking through the fp-ts recipes, and it would be amazing for us to have something similar. No need for a full-blown open source app demonstrating every way in which you might want to use Relude, just an ever-expanding collection of "here's how you solve exactly this problem..."
Some ideas:
bs-deriving
's abilitiesbs-decode
AsyncData
The text was updated successfully, but these errors were encountered: