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

Provide require instructions on site or at least mention there's more.. #8

Open
martinklepsch opened this issue Nov 25, 2015 · 12 comments

Comments

@martinklepsch
Copy link
Member

https://twitter.com/logaan/status/669511930734755840

@bhauman
Copy link

bhauman commented Jul 17, 2016

I'm voting this up big time.

Actually the deps.cljs file would be super helpful here... a popup or reveal of a pprinted deps.cljs would be tremendously helpful... I find myself looking in the jar files for this info...

@Deraen
Copy link
Member

Deraen commented Jul 17, 2016

First version of deps.cljs on site is online. I'll tune styles later and perhaps reimplement the site using different tooling. I think it might be the time to move from Bash script to Boot task to build the site :D

@Deraen
Copy link
Member

Deraen commented Jul 17, 2016

Further idea: Show (or link) the extern file.

@bhauman
Copy link

bhauman commented Jul 18, 2016

This is awesome that you are working on this... I don't see the new site though..

@bhauman
Copy link

bhauman commented Jul 18, 2016

Oh I see the code but the the "deps" tag is empty.

@Deraen
Copy link
Member

Deraen commented Jul 18, 2016

Heh, the code didn't work on my server so automated build removed the contents.

@martinklepsch
Copy link
Member Author

@bhauman what exactly are you looking for when you say contents of deps.cljs file?

@martinklepsch
Copy link
Member Author

@bhauman I pushed a new version: http://cljsjs.github.io/ — please let me know if you think it could be improved in any way.

@bhauman
Copy link

bhauman commented Sep 15, 2016

Looks absolutely great!

If you have time...

Under "Show Usage Instructions" Step "2"
I would add some actual example require code like
(ns example.core
(:require
...
[cljsjs.react.dom]
... ))

The reason I'm suggesting this is that most new people are probably going to try and require [cljsjs/react-dom] instead of cljsjs.react.dom and unfortunately there is no rule to translate project/library name to the require namespace.

So making it absolutely explicit with a code example will probably be very helpful for folks. This reduces the ambiguity of the word "require" with a concrete example of what is meant.

Also the initial instructions at the top of the page could provide lein/boot code examples that slide open when you click on lein example or boot example

One more thing: under "Show Usage Instructions" in step "3" I would make the Project Site a link.

These are just suggestions. I really like the new instructions a lot!!

Thanks for taking the time to do this!!

@Deraen
Copy link
Member

Deraen commented Sep 15, 2016

Full ns example now included.

@burn2delete
Copy link

There are a few formatting cleanups that could be done for mobile with the new site :) looks great tho!

@martinklepsch
Copy link
Member Author

martinklepsch commented Sep 15, 2016

@flyboarder please don't leave us hanging with this and and leave issues with screenshots :)

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

4 participants