hedyhli / hedyhli/starcli

Documentation Update

Open
#132 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
581
Forks
56
PR merge metrics
No merged PRs in 30d

Description

I think the documentation for the project may need a few updates.

Most visible example:
Command: starcli -d this-week -L table
Error: Invalid value for '--date-range' / '-d': invalid choice: this-week. (choose from day, week, month)

The argument "this-week" is not valid for "-d" option as of the latest version, only day/week/month are working.

This is just an example, which I assume was being used as a proper command in the earlier versions, but it is not working now.
Also, the README.md file was updated 2 years ago, so I am assuming you have at least some catching up to do with the new features/updates being added since then, if any.

I don't think this is a "bug" or a "feature request" specifically, so I opened this as a blank issue, thinking it can be labelled as "documentation".
If you have any particular things to be added in the documentation (along with the above update), I would love to work on this.

Contributor guide

Open the contributing guide

Research direction

Start with README.md and compare its command examples with the current starcli option behavior, especially `-d`/`--date-range`. Confirm which date-range values work, update the invalid `this-week` example, and bring other clearly outdated documentation in line with current features.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.