clojure / clojure/clojurescript-site
Quick start stops with Windows-specific commands halfway through
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 107
- Forks
- 130
- PR merge metrics
- No merged PRs in 30d
Description
In the ClojureScript Quick Start in the early parts every command will be duplicated for "Mac or GNU/Linux" and "Windows". E.g.:
Rebuild on Mac or GNU/Linux:
java -cp cljs.jar:src clojure.main build.cljOn Windows:
java -cp "cljs.jar;src" clojure.main build.clj
From the Auto-building section on it stops doing so, with only *nix style instructions, e.g.:
Let’s start auto building:
java -cp cljs.jar:src clojure.main watch.clj
This caught me off guard. I copy/pasted the above to my Powershell prompt but was met with:
Error: Could not find or load main class clojure.main
Which, in hindsight, makes sense.
It might be good to either include Windows-specific instructions everywhere, or leave them out everywhere with only a heads up at the start of the tutorial.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the ClojureScript Quick Start guide, especially the Auto-building section and its command examples. Compare its platform instructions with the earlier rebuild section, then make the platform guidance consistent throughout the tutorial. Done means Windows users are not given Unix-only commands without an appropriate explanation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure, java, powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100