Apply spell/style check to top level markdown files

.github/styles/Google/Acronyms.yml

@@ -62,3 +62,5 @@ exceptions:
   - XSS
   - YAML
   - ZIP
+  - RPC
+  - gRPC

.github/styles/Vocab/Docs/accept.txt

@@ -1,3 +1,22 @@
-Restate
+(?i)Restate
 AWS
 Awakeables
+RPC
+npm
+npx
+application/json
+application
+Podman
+sharded
+(?i)Unkeyed
+(?i)suspendable
+enqueued
+(?i)implement
+serverless
+UUID
+uuid
+idempotency
+boolean
+exactly-once
+backoff
+Jaeger

.github/workflows/test-build.yml

@@ -12,6 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run vale spell and style check
+        continue-on-error: true
         uses: errata-ai/vale-action@reviewdog
         with:
           files: docs

.vale.ini

@@ -6,8 +6,10 @@ MinAlertLevel = suggestion
 
 Packages = Google, proselint, write-good
 
-[*.md]
-BasedOnStyles = Vale, Google, proselint, write-good
+# The "formats" section allows you to associate an "unknown" format
+# with one of Vale's supported formats.
+[formats]
+mdx = md
 
-[*.mdx]
+[*.md]
 BasedOnStyles = Vale, Google, proselint, write-good

docs/examples.md

@@ -7,7 +7,7 @@ description: ""
 # Examples
 
 Do you want to see Restate in action?
-[Here](https://github.com/restatedev/examples) are some ready-to-run examples for you.
+[Here](https://github.com/restatedev/examples) you find some ready-to-run examples.
 Pick an example from the list below and follow the instructions in the README to run it.
 
 ## Starter examples
@@ -18,7 +18,7 @@ Pick an example from the list below and follow the instructions in the README to
 ## Intermediate examples
 
 - [Ticket reservation system](https://github.com/restatedev/examples/tree/main/typescript/ticket-reservation):  a subset of a ticket booking system to illustrate how Restate's keyed-sharding and concurrency guarantees simplify microservice architectures.
-- [Food ordering](https://github.com/restatedev/examples/tree/main/typescript/food-ordering): The order processing middleware of a fast food chain implemented with awakeables and delayed calls.
+- [Food ordering](https://github.com/restatedev/examples/tree/main/typescript/food-ordering): The order processing app of a fast food chain implemented with Awakeables and delayed calls.
 
 ## Advanced examples
 

docs/quickstart.mdx

@@ -32,7 +32,7 @@ npm install && npm run build
 Now, you are all set to start developing your service in `src/app.ts`.
 
 ## Step 3: Build and Run the Greeter service
-Once you are done with implementing your service, build the app and run it:
+Once you have implemented your service, build the app and run it:
 ```shell
 npm run build
 npm run app
@@ -84,7 +84,7 @@ Invoke the function via:
 curl -X POST http://localhost:9090/myservice/hello -H 'content-type: application/json' -d '{"request": "Pete"}'
 ```
 
-That's it! You managed to run your first Restate service.
+Congratulations, you managed to run your first Restate service.
 
 ## Next steps