Skip to content

chore: Expose make gen-docs task

Patrick Bajao requested to merge pb-utilize-gen-docs into main

Description

This project has an existing make gen-docs task that calls go run ./cmd/gen-docs/docs.go to generate docs for commands.

This MR exposes that task in the documentation. Also updates CI config to use the make task just like other tasks we use in the CI.

Regenerated docs because I updated the note being added by cmd/gen-docs/docs.go as a separate commit so it's easier to review the changes.

Related Issues

Resolves #1224 (closed)

How has this been tested?

Run make gen-docs and see if it's successful.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation
  • Chore (Related to CI or Packaging to platforms)
Edited by Patrick Bajao

Merge request reports