Repository navigation
Documents mention search but give no information #4887
Description
Describe the feature or problem you’d like to solve
Looking to be able to use gh issue list --search but the documents mention it without giving any specifics or where to find the information.
Proposed solution
Provide links to https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests in the documents for both gh issue and gh pr - this will at least tell the users where to look.
Additional context
I would try to generate a patch for this myself but it is not clear to me where the source for the manual is available.
Activity
mislav commentedon Dec 13, 2021
@GadgetSteve Thank you for raising this issue.
Out project layout documentation has some pointers about where the code for an individual command can be found, but we don't also document the fact that command documentation is embedded in its Go code. For example,
gh issue listdocumentation:cli/pkg/cmd/issue/list/list.go
Lines 55 to 64 in 2d0b946
Observe the
Use,Short,Long(this command doesn't seem to have it), andExamplefields. Every gh command (implemented as a Cobra command) has these strings which are later taken into account when generating documentation. To add/edit documentation, you can submit PRs to change these strings.