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

Auto Generate doc PRs for updates to CLI commands

Open
  • Is something wrong?
#48 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
cli, documentation

Research direction

Inspect the CLI commands under blitz/packages/cli and the existing documentation under docs/cli. Start by checking how oclif exposes command documentation and how documentation changes are currently published. Done means that adding a CLI command can produce an update to the corresponding CLI docs through an automated pull request.

Written by the indexing model from the issue text.

Description

scope/documentation status/icebox type/enhancement

Idea from @aem:

When there's a new command added in blitz/packages/cli parse out the command and then use the built in oclif documentation to update the cli docs

Dominant language
MDX
Stars
187
Forks
317
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 blitz-js/blitzjs.com

All issues in blitz-js/blitzjs.com

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.