luminus-framework / luminus-framework/luminus

Update documentation for Boot

Open
#196 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
626
Forks
122
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing ClojureScript documentation and the linked luminus-template pull request. Compare the current Leiningen instructions with the Boot tasks and app.cljs.edn setup mentioned in the issue, then decide whether to combine or separate the guidance. Done means Boot users can follow the relevant documentation pages successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.