CCM-17943: Add function Readme documentation #4921

Job	Run time
Set CI/CD metadata	8s
Commit stage / Check Markdown format	9s
Commit stage / Check for changes to event schema package compared to main branch	4s
Commit stage / Scan secrets	15s
Commit stage / Detect Terraform Changes	5s
Commit stage / Check English usage	13s
Commit stage / Check file format	12s
Commit stage / Count lines of code	14s
Commit stage / Scan dependencies	1m 7s
Commit stage / Check TODO usage	8s
Commit stage / Check event schema version has been updated	4s
Commit stage / Check for event schemas package version change	13s
Commit stage / Run terraform-docs	0s
Commit stage / Lint Terraform	0s
Test stage / Pact tests	1m 9s
Test stage / Unit tests	3m 38s
Test stage / Linting	3m 25s
Test stage / Check generated dependencies	1m 2s
Test stage / Typecheck	2m 1s
Test stage / Perform static analysis	1m 1s
Test stage / Test coverage	7s
Build stage / Create Dynamic Environment	6m 6s
Build stage / Build Docs	1m 18s
Build stage / Build OAS spec for sandbox	57s
Build stage / Build OAS spec for PR	1m 0s
Build stage / Build OAS spec for main	0s
Build stage / OAS spec ready	3s
Build stage / Build SDKs	1m 22s
Build stage / Populate Supplier Config	52s
Build stage / Build proxies	-1s
Acceptance stage / Run Acceptance Tests	7m 55s
Publish stage	-1s
	34m 46s

Provide feedback