ecelis / ecelis/sck

Add documentation

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
4
Forks
3
PR merge metrics
No merged PRs in 30d

Description

There is **0** documentation, in a GUI software maybe dialing extensions is not hard to do without a user guide, but in a command line client users expect at least a `--help` parameter.

I think a collection of `.rst` files for the list of topics bellow will do:
- Install
- Configuration
- Dialing extensions

Later I can add sphinx support, but right now these 3 topics require proper documentation.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the command-line client and its existing `--help` behavior to understand the user-facing workflow. Create `.rst` documentation covering Install, Configuration, and Dialing extensions. Done means all three topics have clear user guidance, with no Sphinx setup required yet.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.