Merge pull request #1100 from alegrey91/docs/generate-ref-crd-documentation

docs: generate ref crd documentation

Author: fabriziosestito

CONTRIBUTING.md

@@ -74,6 +74,8 @@ When you make changes to the CRDs in `/api` or rbac rules annotations, you need
 make generate
 ```
 
+This will automatically update the API reference documentation in [`docs/crds`](docs/crds/README.md).
+
 ## Writing Tests
 
 **Controller Tests**

Makefile

@@ -104,7 +104,7 @@ mcp-image:
 	@echo "Built $(REGISTRY)/$(REPO)/mcp:$(TAG)"
 
 .PHONY: generate
-generate: generate-controller generate-storage generate-chart generate-mocks
+generate: generate-controller generate-storage generate-chart generate-mocks generate-docs
 
 .PHONY: generate-controller
 generate-controller: manifests  ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
@@ -136,6 +136,10 @@ generate-chart: ## Generate Helm chart values schema.
 generate-mocks: ## Generate mocks for testing.
 	$(MOCKERY)
 
+.PHONY: generate-docs
+generate-docs: ## Generate API documentation for CRDs.
+	$(MAKE) -C docs/crds
+
 .PHONY: generate-fixtures
 generate-fixtures: ## Generate test fixtures.
 	$(GO_BUILD_ENV) go run ./hack/generate_fixtures.go ./test/fixtures

README.md

@@ -17,6 +17,7 @@ This is still being developed. For additional details, please refer to the [RFC]
 - [Quickstart](https://github.com/kubewarden/sbomscanner/blob/main/docs/installation/quickstart.md)
 - [Uninstall](https://github.com/kubewarden/sbomscanner/blob/main/docs/installation/uninstall.md)
 - [Helm Chart Values Configuration](https://github.com/kubewarden/sbomscanner/blob/main/docs/installation/helm-values.md)
+- [CRDs Documenation](https://github.com/kubewarden/sbomscanner/blob/main/docs/crds/CRD-docs-for-docs-repo.md)
 
 ### Usage