📝 docs: polish puml and index page [no ci]

Signed-off-by: Haili Zhang <haili.zhang@outlook.com>

Author: webup

docs/README.md

@@ -2,21 +2,19 @@
 
 This directory contains advanced docs around the Functions Framework.
 
-- [Testing events and Pub/Sub](events.md)
 - [Testing Functions](testing-functions.md)
 - [Debugging Functions](debugging.md)
-- [Running and Deploying Docker Containers](docker.md)
-- [Writing a Function in Typescript](typescript.md)
+- [Writing a Function in TypeScript](typescript.md)
 - [ES Modules](esm/README.md)
 
+Also containing sequence diagrams of OpenFunction underlying workflows.
+
+- [OpenFunction in Sync Runtime](uml/OpenFunction%20in%20Sync%20Runtime.png)
+- [OpenFunction in Async Runtime](uml/OpenFunction%20in%20Async%20Runtime.png)
+
 ## Generated Docs
 
 The `generated/` directory contains generated API references.
 
 - [api.md](generated/api.md)
-- [api.d.ts](generated/api.d.ts)
 - [api.json](generated/api.json)
-
-## TODO Docs
-
-- Run Multiple Cloud Functions [#23](https://github.com/GoogleCloudPlatform/functions-framework-nodejs/issues/23)

docs/uml/OpenFunction in Async Runtime.png

@@ -1,4 +1,4 @@
-@startuml Async Server
+@startuml OpenFunction in Async Runtime
 
 box Function Process in Local Environment or Container
 control ENTRYPOINT

docs/uml/OpenFunction in Sync Runtime.png

@@ -1,4 +1,4 @@
-@startuml HTTP Binding
+@startuml OpenFunction in Sync Runtime
 
 box Function Process in Local Environment or Container
 control ENTRYPOINT
@@ -9,7 +9,6 @@ participant Express [
   ----
   ""Express""
 ]
-participant Interceptor
 participant "User Function" as UserFunction
 participant DaprClient
 end box
@@ -22,22 +21,14 @@ ENTRYPOINT -> Main ** : execute
 note over ENTRYPOINT, Main: Pass through __CLI arguments__ and \ncontainer __environment variables__
 
 Main -> Main : load user function file
-note left: ""function (req, res) {}"" 
+note left: ""function (ctx, data)"" 
 
 Main -> Server ** : create
 note over Main, Server: Hand over __user function__, __function type__ \nand __context__ parsed from env variables 
 
 Server -> Express ** : new
 
-Server -> Express : use init middleware
-note over Server, Express: Store context in ""res.locals.context""
-
-Server -> Interceptor ** : new
-Server -> Express : use interceptor
-|||
-Server -> Express : use others middlewares
-|||
-Server -> UserFunction ** : wrap user function
+Server -> UserFunction ** : wrap user function in ""function (req, res)""
 note over Server, UserFunction: Use Node.js ""Domain"" to run function and catch exceptions  
 Server -> Express : bind wrapper to "/*" route
 
@@ -48,27 +39,28 @@ Server -> Express : bind wrapper to "/*" route
 [-> Express ++ : HTTP request to "/"
 
 Express -> UserFunction ++ : execute user function
-UserFunction --> Express -- : return execution result "data"
 
-alt ""runtime"" = ""knative"" and ""outputs"" is not empty
-  Express -> Interceptor ++ : invoke interceptor
 
-  Interceptor -> Interceptor : load context
-  Interceptor -> DaprClient ** : new
+alt output to Dapr
+  UserFunction -> DaprClient ** : new
 
   loop each OpenFunction Output 
-    Interceptor -> DaprClient ++ : send "data"
+    UserFunction -> DaprClient ++ : send "data" asynchronously
 
-    DaprClient -> DaprSidecar ++ : invoke binding or publication with "data"
+    DaprClient -> DaprSidecar ++ : invoke binding \nor pub with "data"
     DaprSidecar --> DaprClient -- : return result 
 
-    DaprClient --> Interceptor -- : forward result
   end
 
-  Interceptor -> DaprClient !!
-  Interceptor --> Express -- : return "data" as response
+  UserFunction -> DaprClient !!
+end
+
+alt response via Express
+  UserFunction -> UserFunction : invoke ""ctx.res"" \n(and ""ctx.req"") methods 
 end
 
+UserFunction --> Express -- : wrapper ends response
+
 [<- Express -- : send response
 
 ...