Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

README Generation

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reading the CLI command definitions and the existing README to understand how command information is represented and documented. Determine how generated CLI information, including the possible command tree, should be exposed and what README output would count as complete.

Written by the indexing model from the issue text.

Description

enhancement

Add commands which automatically update the readme with cli information generated from the code, such as the possible command tree

Dominant language
TypeScript
Stars
79
Forks
23
Avg merge
2d 12h
Merged PRs (30d)
2

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.

More from solidjs-community/solid-cli

All issues in solidjs-community/solid-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.