Enhancement: Generate markdown from viper/cobra.command

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the cobra.Command definition and the README content it should maintain. Check whether the repository already has command help or documentation generation, then define completion as reproducible Markdown output from the command that keeps the README current. No test or file path is named in the issue, so the relevant entry points must be found in the repository.

Written by the indexing model from the issue text.

Description

enhancement good first issue

It is possible to generate markdown from cobra.command automatically. This should be supported and help to maintain the readme.

Dominant language
Go
Stars
151
Forks
7
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 replicate/pget

All issues in replicate/pget

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.