fix: check markdown grammar issues

.github/markdown_lint_config.json

@@ -0,0 +1,52 @@
+{
+  "MD001": true,
+  "MD002": false,
+  "MD003": false,
+  "MD004": false,
+  "MD005": false,
+  "MD006": false,
+  "MD007": false,
+  "MD008": false,
+  "MD009": false,
+  "MD010": false,
+  "MD011": false,
+  "MD012": false,
+  "MD013": false,
+  "MD014": false,
+  "MD015": false,
+  "MD016": false,
+  "MD017": false,
+  "MD018": false,
+  "MD019": false,
+  "MD020": false,
+  "MD021": false,
+  "MD022": false,
+  "MD023": false,
+  "MD024": false,
+  "MD025": false,
+  "MD026": false,
+  "MD027": false,
+  "MD028": false,
+  "MD029": false,
+  "MD030": false,
+  "MD031": true,
+  "MD032": false,
+  "MD033": false,
+  "MD034": false,
+  "MD035": false,
+  "MD036": false,
+  "MD037": true,
+  "MD038": true,
+  "MD039": false,
+  "MD040": false,
+  "MD041": false,
+  "MD042": false,
+  "MD043": false,
+  "MD044": false,
+  "MD045": false,
+  "MD046": false,
+  "MD047": false,
+  "MD048": false,
+  "MD049": false,
+  "MD050": false
+}

.github/workflows/markdown-linter.yml

@@ -0,0 +1,20 @@
+name: Layotto Env Pipeline 🌊
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check:
+    name: "🍀 Markdown Lint"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Check markdown grammar in the docs directory
+        uses: nosborn/[email protected]
+        with:
+          files: docs/*
+          config_file: ".github/markdown_lint_config.json"

docs/en/api_reference/appcallback_v1.md

@@ -12,7 +12,7 @@ This document is automaticallly generated from the [`.proto`](https://github.com
 
 <a name="spec.proto.runtime.v1.AppCallback"></a>
 
-### [gRPC Service] AppCallback
+## [gRPC Service] AppCallback
 AppCallback V1 allows user application to interact with runtime.
 User application needs to implement AppCallback service if it needs to
 receive message from runtime.
@@ -28,7 +28,7 @@ receive message from runtime.
 <a name="spec.proto.runtime.v1.ListTopicSubscriptionsResponse"></a>
 <p align="right"><a href="#top">Top</a></p>
 
-### ListTopicSubscriptionsResponse
+## ListTopicSubscriptionsResponse
 ListTopicSubscriptionsResponse is the message including the list of the subscribing topics.
 
 
@@ -44,7 +44,7 @@ ListTopicSubscriptionsResponse is the message including the list of the subscrib
 <a name="spec.proto.runtime.v1.TopicEventRequest"></a>
 <p align="right"><a href="#top">Top</a></p>
 
-### TopicEventRequest
+## TopicEventRequest
 TopicEventRequest message is compatible with CloudEvent spec v1.0
 https://github.com/cloudevents/spec/blob/v1.0/spec.md
 
@@ -69,7 +69,7 @@ https://github.com/cloudevents/spec/blob/v1.0/spec.md
 <a name="spec.proto.runtime.v1.TopicEventRequest.MetadataEntry"></a>
 <p align="right"><a href="#top">Top</a></p>
 
-### TopicEventRequest.MetadataEntry
+## TopicEventRequest.MetadataEntry
 
 
 
@@ -86,7 +86,7 @@ https://github.com/cloudevents/spec/blob/v1.0/spec.md
 <a name="spec.proto.runtime.v1.TopicEventResponse"></a>
 <p align="right"><a href="#top">Top</a></p>
 
-### TopicEventResponse
+## TopicEventResponse
 TopicEventResponse is response from app on published message
 
 
@@ -102,7 +102,7 @@ TopicEventResponse is response from app on published message
 <a name="spec.proto.runtime.v1.TopicSubscription"></a>
 <p align="right"><a href="#top">Top</a></p>
 
-### TopicSubscription
+## TopicSubscription
 TopicSubscription represents topic and metadata.
 
 
@@ -120,7 +120,7 @@ TopicSubscription represents topic and metadata.
 <a name="spec.proto.runtime.v1.TopicSubscription.MetadataEntry"></a>
 <p align="right"><a href="#top">Top</a></p>
 
-### TopicSubscription.MetadataEntry
+## TopicSubscription.MetadataEntry
 
 
 
@@ -138,7 +138,7 @@ TopicSubscription represents topic and metadata.
 
 <a name="spec.proto.runtime.v1.TopicEventResponse.TopicEventResponseStatus"></a>
 
-### TopicEventResponse.TopicEventResponseStatus
+## TopicEventResponse.TopicEventResponseStatus
 TopicEventResponseStatus allows apps to have finer control over handling of the message.
 
 | Name | Number | Description |

docs/en/api_reference/comment_spec_of_proto.md

@@ -3,6 +3,7 @@
 
 Avoid adding empty lines between comments  symbols `//`.If there is a blank line in the comments, the tool(protoc-gen-doc) will generate malformed documents.
 bad case:
+
 ```
 message  BadCase{
   // XXXXXXXX
@@ -13,7 +14,9 @@ message  BadCase{
   field A
 }
 ```
+
 good case:
+
 ```
 message  GoodCase{
   // XXXXXXXX
@@ -22,11 +25,13 @@ message  GoodCase{
   field A
 }
 ```
+
 Or you can use another annotation symbol directly `/*  */`
 
 
 If you want to have some comment in your proto files, but don't want them to be part of the docs, you can simply prefix the comment with `@exclude`.
 Example: include only the comment for the id field
+
 ```
 /**
  * @exclude

docs/en/api_reference/how_to_generate_api_doc.md

@@ -4,9 +4,11 @@ Note: the commands below should be executed under layotto directory
 ## How to compile the proto files into `.pb.go` code
 <!-- tabs:start -->
 ### **Make cmmand(recommended)**
+
 ```bash
 make proto.code
 ```
+
 This command uses docker to run protoc and generate `.pb.go` code files.
 
 ### **Install protoc**
@@ -20,15 +22,18 @@ This command uses docker to run protoc and generate `.pb.go` code files.
 cd spec/proto/runtime/v1
 protoc -I. --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=require_unimplemented_servers=false,paths=source_relative *.proto
 ```
+
 <!-- tabs:end -->
 ## How to generate API reference doc according to the proto files
 We can use [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) and docker to generate api documents,the command is as follows:  
 
 <!-- tabs:start -->
 ### **Make command(recommended)**
+
 ```bash
 make proto.doc
 ```
+
 This command uses docker to run protoc-gen-doc and generate docs.
 
 ### **Use docker to run protoc-gen-doc**