crickets-and-comb / crickets-and-comb/reference_package

Update README `list-makes` example

Open
#45 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

In a number of Crickets and Comb repos, the README uses the wrong command for the example of how to list the available make targets. It uses `make list-targets`, but it should be `make list-makes`. We need to update the documentation in each of these repos.

See https://github.com/crickets-and-comb/bfb_delivery/pull/162/

Contributor guide

Open the contributing guide

Research direction

Review the README files in the affected Crickets and Comb repositories, beginning with reference_package and the linked bfb_delivery pull request. Find the list-makes example, update `make list-targets` to `make list-makes`, and confirm each affected repository's README uses the corrected command.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.