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 documentation for Boot #196

Open
DonyorM opened this issue Aug 1, 2017 · 2 comments
Open

Update documentation for Boot #196

DonyorM opened this issue Aug 1, 2017 · 2 comments

Comments

@DonyorM
Copy link
Member

DonyorM commented Aug 1, 2017

Recently luminus gained support for creating a project built with boot. Right now, understandably, the luminus website only has documentation for lein projects. It would be great to document how to use boot with luminus as well.

What would be the best way to go about this?

We could simply have both in one page, but for pages like the ClojureScript documentation, this takes up a lot of space, since we need to specify the boot tasks required and the commands to run them (including adding an app.cljs.edn file). There aren't too many pages like this, so it may be worth just giving people a bit more to read through.

Alternatively, we could consider adding javascript or clojurescript to the project and allowing users to set whether or not they use boot or lein, and then displaying only the documentation for that version. This is a bit more complicated, and thus more likely to break, but cleaner to the end user if doesn't break.

@yogthos
Copy link
Member

yogthos commented Aug 1, 2017

I think adding a bit of js to toggle lein/boot docs would work. Could wrap them in divs with respective clases, e.g:

<div id="lein">
lein docs
</div>
<div id="boot">
boot docs
</div>

This could be done directly in the markdown docs. Then, the script in the page could check if the classes exist and add a button to toggle their visibility.

@DonyorM
Copy link
Member Author

DonyorM commented Aug 1, 2017

Cool that sounds good. I'll start working on that some when I have time.

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

2 participants