coala / coala/documentation

Write the getting started with coala tutorial in a jupyter notebook.

Open
#132 5 comments 1 reaction 0 assignees View on GitHub
cool and awesome status/stale
Dominant language
Python
Stars
40
Forks
172
PR merge metrics
No merged PRs in 30d

Description

Rewriting it in jupyter, will allow us to add comments and actually let the users execute the code locally. It would be a more interactive and immersive experience for user.

Maybe we can include it already with `coala` and invoke it with `coala tutorial` maybe.

Thoughts @Adrianzatreanu ?

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the current getting-started tutorial in the coala documentation and review how existing documentation is organized. Clarify whether the scope is only an executable Jupyter notebook or also a `coala tutorial` command; done means the tutorial is interactive, locally runnable, and integrated into the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.