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

Update FAQ with some references for machinist, kind projector and simulacrum #1183

Merged

Conversation

mikejcurry
Copy link
Contributor

Just noticed that these sections were basically left blank so threw in some text for them.

Happy to tweak if required, but I think this at least provides a pointer in the right direction.

@codecov-io
Copy link

codecov-io commented Jul 10, 2016

Current coverage is 88.79%

Merging #1183 into master will not change coverage

@@             master      #1183   diff @@
==========================================
  Files           233        233          
  Lines          3079       3079          
  Methods        3025       3025          
  Messages          0          0          
  Branches         51         51          
==========================================
  Hits           2734       2734          
  Misses          345        345          
  Partials          0          0          

Sunburst

Powered by Codecov. Last updated by 341b188...b705c4e

@milessabin
Copy link
Member

👍

@@ -16,7 +16,7 @@ section: "faq"
* [What does `macro Ops` do? What is `cats.macros.Ops`?](#machinist)
* [How can I help?](#contributing)

## What imports do I need?<a id="what-imports" href="#what-imports"></a>
## <a id="what-imports" href="#what-imports"></a>What imports do I need?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put the links at the end of the header because I added a bit of CSS that makes an anchor pop up with a link for each header and if it's on the left side, the header text shifts around which is a bit disorienting. This is something that isn't noticeable if you are just looking at the markdown view, but it will be noticeable once the FAQ is deployed on the site.

I'm definitely open to better options -- I was just looking for low-hanging fruit for easy FAQ links that I could implement with very limited CSS skills :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ceedubs - so the reason I switched the order, was that when I tested locally, when the anchor was defined after the text, I built locally and tested the page, and the problem was that clicking the link brought me to just after the heading. So, as the page is a bit larger now, that actually meant that the heading was not visible, and I had to scroll in reverse to see the heading. I thought this would be confusing for anyone who clicked a link not to be able to see the heading of the link they clicked on so I switched the anchor to earlier. I agree about the anchor, but I think it might actually be worse not to be able to see the heading.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikejcurry ah I see. That makes sense. Let's go with your approach, and hopefully someone will be annoyed enough by the jumping text that they'll fix it for us :P

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My own CSS skills aren't particularly advanced, but if I get some time I'll come back to these links and see if I can find a better way.

@ceedubs
Copy link
Contributor

ceedubs commented Jul 11, 2016

I left a couple minor comments, but this is great. Thanks @mikejcurry! Let me know what you think about the comments that I left.

@non
Copy link
Contributor

non commented Jul 13, 2016

This looks great to me. I think the minor comments might be right, but I'm also happy to merge sooner and then fix issues in a future PR. 👍

@mikejcurry
Copy link
Contributor Author

Cheers, I think the minor comments have been addressed now - unless I missed something along the way.

Thanks!

@ceedubs
Copy link
Contributor

ceedubs commented Jul 13, 2016

Fantastic. Thanks @mikejcurry!

@ceedubs ceedubs merged commit 0d36ff3 into typelevel:master Jul 13, 2016
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

Successfully merging this pull request may close these issues.

6 participants