Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Provide a minimal complete example on how to jack-in #779

Open
beders opened this issue Sep 6, 2020 · 4 comments
Open

Provide a minimal complete example on how to jack-in #779

beders opened this issue Sep 6, 2020 · 4 comments
Labels
documentation Better documentation needed. good first issue Good for newcomers

Comments

@beders
Copy link

beders commented Sep 6, 2020

To make the VSCode+Calva combination more attractive to newcomers, lower some of the barriers of entry.
That means, in Getting Started, show a simple way to get from an empty directory to having a REPL ready to go.
This doesn't force people to step away from the Calva docs to research lein oder tools-deps.
Instead, provide two minimal example files that Calva accepts as a valid starting point.

@bpringe bpringe added the documentation Better documentation needed. label Sep 6, 2020
@bpringe
Copy link
Member

bpringe commented Sep 6, 2020

Hi @beders. First of all, thank you very much for your sponsorship! I like this suggestion.

@bpringe
Copy link
Member

bpringe commented Sep 6, 2020

Just making a note here that what we document for this task may depend on what changes are made per #780, so we should wait to document this until that issue is resolved.

@practicalli-johnny
Copy link

This is the jack-in guide for VSCode & Calva we've used for ClojureBridgeLondon (its about 9 months old, so might need tweaking)

http://practicalli.github.io/clojure/clojure-editors/editor-user-guides/vscode-calva.html

I can work on the documentation in November if its still outstanding.

@bpringe
Copy link
Member

bpringe commented Oct 23, 2020

Thanks for the link. Yeah, that guide is from before we added the new output/repl window, I think. That would be great if you worked on the docs for this!

See here for instructions on editing the docs, it's pretty simple: https://github.com/BetterThanTomorrow/calva/wiki/How-to-Hack-on-Calva#editing-documentation

@bpringe bpringe added the good first issue Good for newcomers label Dec 28, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Better documentation needed. good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants