Getting started guide and interactive notebooks
Open
documentation
for future
- Dominant language
- Python
- Stars
- 50
- Forks
- 17
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 3
Description
We should lower the hurdle for newcomers to Besca and extend the documentation with a "Getting started" guide, which explains the installation and first steps even for Python newbies. We can also include interacitve notebooks using Binder (https://mybinder.org).
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the existing documentation and installation instructions first, then identify the first Besca workflow that a Python newcomer should follow. Define the guide's setup and first steps, and add interactive notebooks that can run through Binder. Done means newcomers can install Besca, complete the initial workflow, and launch the notebooks.
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
- Mostly clear
- Newbie friendliness
- 42/100