unjs / unjs/citty

📒 Documentation

Open
#46 11 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.3k
Forks
58
PR merge metrics
No merged PRs in 30d

Description

Describe the feature

Hi 👋🏻

I'm fan of creating CLI application. I have typer library that does really good job in python. In JS, I plan to use citty but there's lack of documentation for me & my colleagues to get started and fully leverage it.

Can we have a dedicated documentation site for citty like unstorage & others?

P.S. Some of the unjs projects don't have enough docs to understand the value it provides 😞

Additional information
  • Would you be willing to help implement this feature?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing citty's existing documentation and comparing it with the linked unstorage documentation site. Done means providing a dedicated documentation site that helps newcomers get started and understand citty's capabilities.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.