From 66f283e26946b7efef2344bf375992ae230fb020 Mon Sep 17 00:00:00 2001 From: nikhilkalburgi Date: Wed, 3 Jan 2024 12:50:50 +0530 Subject: [PATCH] docs: highlight code tags, correct typos and and adjust servers codeblock highlight in tutorials __Enhancement:__ The code tags should appear bold everywhere in the docs __Typo:__ Found some typos in tutorials + missing of proper redirects. __Fix:__ The Codeblock in servers.md in not hightlighted correctly. Signed-off-by: nikhilkalburgi --- pages/docs/tutorials/getting-started/asyncapi-documents.md | 2 +- pages/docs/tutorials/getting-started/hello-world.md | 2 +- pages/docs/tutorials/getting-started/request-reply.md | 2 +- pages/docs/tutorials/getting-started/servers.md | 2 +- styles/globals.css | 4 ++++ 5 files changed, 8 insertions(+), 4 deletions(-) diff --git a/pages/docs/tutorials/getting-started/asyncapi-documents.md b/pages/docs/tutorials/getting-started/asyncapi-documents.md index 6d11ace3144..52bbb5a637c 100644 --- a/pages/docs/tutorials/getting-started/asyncapi-documents.md +++ b/pages/docs/tutorials/getting-started/asyncapi-documents.md @@ -9,7 +9,7 @@ weight: 101 An AsyncAPI document is a file that defines and annotates the different components of **a specific Event-Driven API**. -The file format must be JSON or YAML; however, only the subset of YAML that matches the JSON capabilities is allowed. +The file format must be [JSON](https://www.json.org/json-en.html) or [YAML](https://yaml.org/); however, only the subset of YAML that matches the JSON capabilities is allowed. Below we have an example AsyncAPI document in YAML file format. {`asyncapi: 3.0.0 diff --git a/pages/docs/tutorials/getting-started/hello-world.md b/pages/docs/tutorials/getting-started/hello-world.md index 654c809011f..87e38cb2b51 100644 --- a/pages/docs/tutorials/getting-started/hello-world.md +++ b/pages/docs/tutorials/getting-started/hello-world.md @@ -25,7 +25,7 @@ operations: $ref: '#/channels/hello'`} -Let's get into the details of this sample AsyncAPI document: +Let's get into the details of this sample [AsyncAPI document](../../concepts/asyncapi-document): {`asyncapi: 3.0.0 diff --git a/pages/docs/tutorials/getting-started/request-reply.md b/pages/docs/tutorials/getting-started/request-reply.md index fcbdd0e6b0d..747c8a6d85d 100644 --- a/pages/docs/tutorials/getting-started/request-reply.md +++ b/pages/docs/tutorials/getting-started/request-reply.md @@ -3,7 +3,7 @@ title: Request/reply pattern weight: 40 --- -In this tutorial, you'll learn how to implement the request/reply pattern in an AsyncAPI document using a straightforward pong-pong example. +In this tutorial, you'll learn how to implement the request/reply pattern in an AsyncAPI document using a straightforward ping-pong example. Before we begin, it would be beneficial for you to have a basic understanding of AsyncAPI and Event-Driven Architectures (EDA). If you need a refresher, refer to our [Event-Driven Architecture](/docs/tutorials/getting-started/event-driven-architectures) document. diff --git a/pages/docs/tutorials/getting-started/servers.md b/pages/docs/tutorials/getting-started/servers.md index 6bca604ebe6..ba0c6f0ddeb 100644 --- a/pages/docs/tutorials/getting-started/servers.md +++ b/pages/docs/tutorials/getting-started/servers.md @@ -11,7 +11,7 @@ In the previous lesson, you learned how to create the definition of a simple [He In this tutorial, you'll learn how to add `servers` to your AsyncAPI document. Adding and defining servers is useful because it specifies where and how to connect. The connection facilitates where to send and receive messages. - + {`asyncapi: 3.0.0 info: title: Hello world application diff --git a/styles/globals.css b/styles/globals.css index 114687bfa1d..39dfbaa3c45 100644 --- a/styles/globals.css +++ b/styles/globals.css @@ -340,4 +340,8 @@ abbr[title] { .meeting-card:hover > div:nth-child(2) > p { color: white; +} + +code{ + font-weight: bold; } \ No newline at end of file