CCM-17943: Add function Readme documentation #4909

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

Provide feedback