JakeWharton / JakeWharton/cardiologist

Move usage documentation out of README and into docsite

Open
#99 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
198
Forks
6
Avg merge
2d 11h
Merged PRs (30d)
8

Description

The documentation should cover the following:

1. Getting started
2. How do I build a job schedule?
3. How do I stop jobs from executing concurrently?
4. How do I schedule a one-off job?
5. How do I name jobs?
6. How many jobs can cardiologist run concurrently?
7. How do I persist my jobs (and why doesn't cardiologist do this for me?)
8. What's the difference between cardiologist and cron?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the README and locating the docsite structure. Move the listed usage topics into the docsite, leaving the README focused on project overview and linking to the detailed guidance; done means all eight questions are covered and the README no longer contains the usage documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.