Skip to content

docs: add help documentation for 13 missing Makefile targets#401

Merged
weng271190436 merged 3 commits intomainfrom
copilot/fix-docs-missing-make-targets
Jan 8, 2026
Merged

docs: add help documentation for 13 missing Makefile targets#401
weng271190436 merged 3 commits intomainfrom
copilot/fix-docs-missing-make-targets

Conversation

Copy link
Contributor

Copilot AI commented Jan 8, 2026

make help only displayed 12 of 25 user-facing targets. Development workflow commands like lint, e2e-tests, reviewable, and Docker build targets were undiscoverable.

Changes

Added ## Description comments to 13 targets:

Testing & Development:

  • lint - Run fast linting
  • staticcheck - Run static analysis
  • e2e-tests - Run E2E tests
  • e2e-tests-custom - Run custom E2E tests with labels
  • setup-clusters - Set up Kind clusters for E2E testing
  • clean-e2e-tests - Clean up E2E test clusters

Code Generation:

  • generate - Generate deep copy methods
  • manifests - Generate CRDs and manifests

Quality & CI:

  • reviewable - Run all quality checks before PR

Docker Images:

  • push - Build and push all Docker images
  • docker-build-hub-agent - Build hub-agent image
  • docker-build-member-agent - Build member-agent image
  • docker-build-refresh-token - Build refresh-token image

Result

make help output showing all 25 targets

make help now displays all 25 targets, improving developer experience and discoverability.

Original prompt

This section details on the original issue you should resolve

<issue_title>[BUG] docs: make help is missing 13 user-facing targets</issue_title>
<issue_description>### Describe the bug
Running make help only shows 12 of the 25 user-facing Makefile targets. Important commands for development workflows are not documented.

To Reproduce

  1. Run make help
  2. Notice important commands are missing

Missing targets (13):

  • lint - Run fast linting (only lint-full is shown)
  • setup-clusters - Set up Kind clusters for E2E testing
  • e2e-tests - Run E2E tests
  • e2e-tests-custom - Run custom E2E tests with labels
  • clean-e2e-tests - Clean up E2E test clusters
  • generate - Generate deep copy methods
  • manifests - Generate CRDs and manifests
  • reviewable - Run all quality checks before PR
  • staticcheck - Run static analysis
  • push - Build and push all Docker images
  • docker-build-hub-agent - Build hub-agent image
  • docker-build-member-agent - Build member-agent image
  • docker-build-refresh-token - Build refresh-token image

Expected behavior

All user-facing targets should have ## Description comments so they appear in make help.

Screenshots

N/A

Additional context

The help target uses awk to find targets with ## comments. Adding ## Description after each target definition will fix this.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: zhiying-lin <54013513+zhiying-lin@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation to include missing Makefile targets docs: Add help documentation for 13 missing Makefile targets Jan 8, 2026
Copilot AI requested a review from zhiying-lin January 8, 2026 02:51
@codecov
Copy link

codecov bot commented Jan 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@zhiying-lin zhiying-lin marked this pull request as ready for review January 8, 2026 08:09
@zhiying-lin zhiying-lin changed the title docs: Add help documentation for 13 missing Makefile targets docs: add help documentation for 13 missing Makefile targets Jan 8, 2026
Signed-off-by: Zhiying Lin <zhiyingl456@gmail.com>
@weng271190436 weng271190436 merged commit c0b45ac into main Jan 8, 2026
19 of 21 checks passed
@weng271190436 weng271190436 deleted the copilot/fix-docs-missing-make-targets branch January 8, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] docs: make help is missing 13 user-facing targets

3 participants