Best way to contribute documentation?

anmonteiro / lumo

Fast, cross-platform, standalone ClojureScript environment

Eclipse Public License 1.0

1.88k stars 84 forks source link

Best way to contribute documentation? #262

Closed mathpunk closed 6 years ago

mathpunk commented 7 years ago

I'd like to try and learn to use lumo and mach for some shell scripting tasks. When I learn things I tend to accumulate a large amount of notes to myself. If you can tell me where I should submit them, I'd be happy to edit these notes so they're useful to more people than just me.

anmonteiro commented 7 years ago

Thanks for your interest!

Feel free to leave them here and I'll transpose them to the future docs website.

It's still very WIP but I'm planning on making it very easy to contribute to the website by simply editing markdown

shakdwipeea commented 7 years ago

I would like to add this.

emacs repl setup

Install https://github.com/clojure-emacs/inf-clojure
run lumo repl using lumo -n <port>
connect using M-x inf-clojure-connect

This can be used for interactive scripting in any buffer with inf-clojure-minor-mode.

Ref: https://www.reddit.com/r/Clojure/comments/5ec8kr/lumo_nodebased_clojurescript_repl_has_a_100/dagvulo/

bhurlow commented 6 years ago

it would be great to have some place to refer to all the lumo functions as distinct from the cljs api.

lumo.build.api
lumo.classpath
lumo.common
lumo.core
lumo.io
lumo.pprint.data

These all seem really useful, but I'm not sure which are intended to be used directly or are stable

arichiardi commented 6 years ago

For all the folks interested in contributing to the doc, there isthe wiki now :smile: Closing this ok?

https://github.com/anmonteiro/lumo/wiki