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.

Sign up for GitHub

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

Jump to bottom

Jump start guide #1017

Closed
adelbertc opened this issue May 5, 2016 · 11 comments
Closed

Jump start guide #1017

adelbertc opened this issue May 5, 2016 · 11 comments
Labels
documentation help wanted

Comments

@adelbertc
Copy link
Contributor

adelbertc commented May 5, 2016 •
edited
Loading

One of my coworkers was looking at the GitHub repo and website and was confused at first because he didn't really understand what constituted "abstractions for functional programming." He said something that would be really helpful is if there was a "jump start guide" of sorts that gives short examples that can get you started.. examples I can think of are Validated, Xor, Traverse/Applicative, Kleisli..

Now the question is where should such a thing live?
@adelbertc adelbertc added this to the cats-1.0.0 milestone May 17, 2016
@kailuowang
Copy link
Contributor

could be part of #1031

@kailuowang kailuowang modified the milestones: 1.0.0-RC1, 1.0.0-MF Apr 11, 2017
@kailuowang kailuowang modified the milestones: 1.0.0, 1.0.0-RC1 Aug 29, 2017
@kailuowang
Copy link
Contributor

Here is a great blog post alone the same line
https://virtuslab.com/blog/cats-library/

@kailuowang kailuowang removed this from the 1.0.0 milestone Nov 10, 2017
@Andrea
Copy link
Contributor

Andrea commented Dec 11, 2017

HI there, kind of starting to look at this. Where should this live? Maybe cats/docs/src/main/tut/JumpStart ?

@kailuowang
Copy link
Contributor

@Andrea thanks! that location looks good to me.

@PawelLipski
Copy link
Contributor

@Andrea @kailuowang I'm the author of the mentioned blog post, please contact me at plipski-at-virtuslab.com about using the examples from the blog in the library docs

@Andrea
Copy link
Contributor

Andrea commented Dec 14, 2017 •
edited
Loading

hey @PawelLipski emailed you yesterday :D If we don't hear anything we ll just go with other examples, no worries.

@Andrea
Copy link
Contributor

Andrea commented Feb 18, 2018 •
edited
Loading

Sorry about the delay, I was hoping to work with some other peeps on this but it's taking too long so I started myself now. I heard back from @PawelLipski I ll put a WIP commit so you can contribute/comment on what's happening

@pauljamescleary
Copy link

fwiw - I was planning to do a write up on abstractions used in the microsite I am building for https://github.com/pauljamescleary/scala-pet-store

@PawelLipski
Copy link
Contributor

Ok great @Andrea, please keep me posted, once you create a PR I can populate the guide file content (in markdown)

@PawelLipski
Copy link
Contributor

@Andrea @kailuowang just created a PR #2178

PawelLipski added a commit to VirtusLab/cats that referenced this issue Apr 7, 2018
@PawelLipski
Add jump start guide (typelevel#1017)
40ab9ac
@PawelLipski
Copy link
Contributor

@Andrea @kailuowang @adelbertc pls take a look at the PR #2178

LukaJCB pushed a commit that referenced this issue May 18, 2018
@PawelLipski
Add jump start guide (#2178)
0944cfe 
* Add jump start guide (#1017)

* Adapt the guide to Cats version 1.0.1

* Fix blog style and formatting

* Remove references to mocks

* Link guide from FAQ instead of main menu
@LukaJCB LukaJCB closed this as completed May 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@Andrea @kailuowang @adelbertc @PawelLipski @LukaJCB @pauljamescleary