From 2587e35ea56eafe9b24df937c68c5af2a4e05cae Mon Sep 17 00:00:00 2001 From: Jagruti Date: Sun, 29 Jan 2023 12:05:19 +0530 Subject: [PATCH 01/31] doc: added the introduction document --- docs/README.md | 9 +++++++++ docs/introduction.md | 18 ++++++++++++++++++ docs/usage.md | 0 3 files changed, 27 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/introduction.md create mode 100644 docs/usage.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..ade567cd6 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +Table of contents + +- [Introduction](introduction.md) +- [Usage](usage.md) +- Navigation +- Editor +- HTML Preview +- Blocks visualizer +- Studio Settings diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 000000000..c89cf5f9e --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,18 @@ +Studio is a tool to develop AsyncAPI documentation. It allows you to visualize the flow, events, publishers, subscribers as you design your API. + +# Studio Use Cases + +- Create and visualize event-driven AsyncAPI on the go. +- Realtime visualization and documentation for your APIs. + + +# Studio Advantages +- User-friendly. +- Straightforward and effortless in building APIs. +- Interactive AsyncAPI documentation. + +# Process + +To start using Studio, [create the AsyncAPI](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) file for your API. + +Use the `Block visualizer` button to toggle the Event Visualizer window from the navigation panel. You will find the navigation panel to the extreme left your screen. \ No newline at end of file diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 000000000..e69de29bb From addb6bf46af22e607b64a60b04c1490b3316dec8 Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Thu, 2 Feb 2023 09:31:35 +0530 Subject: [PATCH 02/31] Update docs/introduction.md Co-authored-by: Alejandra Quetzalli --- docs/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction.md b/docs/introduction.md index c89cf5f9e..3c98fcd81 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -13,6 +13,6 @@ Studio is a tool to develop AsyncAPI documentation. It allows you to visualize t # Process -To start using Studio, [create the AsyncAPI](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) file for your API. +To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) for your API. Use the `Block visualizer` button to toggle the Event Visualizer window from the navigation panel. You will find the navigation panel to the extreme left your screen. \ No newline at end of file From 226f726ce7e0c04a29dae0a5ff6ff8c0b1543894 Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Sat, 4 Feb 2023 11:17:32 +0530 Subject: [PATCH 03/31] Update docs/introduction.md Co-authored-by: Alejandra Quetzalli --- docs/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction.md b/docs/introduction.md index 3c98fcd81..111c99e83 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -11,7 +11,7 @@ Studio is a tool to develop AsyncAPI documentation. It allows you to visualize t - Straightforward and effortless in building APIs. - Interactive AsyncAPI documentation. -# Process +# Usage To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) for your API. From 12ac0ea3a58c0bb0c3f6bd92a168c273e84b3ec4 Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Sat, 4 Feb 2023 11:18:07 +0530 Subject: [PATCH 04/31] Update docs/introduction.md Co-authored-by: Alejandra Quetzalli --- docs/introduction.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/introduction.md b/docs/introduction.md index 111c99e83..0d65aa9b3 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -14,5 +14,10 @@ Studio is a tool to develop AsyncAPI documentation. It allows you to visualize t # Usage To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) for your API. + +If you do not have an `asyncapi.yaml` file ready, then generate one by running: +`asyncapi new --example=tutorial.yml --no-tty`. + + Use the `Block visualizer` button to toggle the Event Visualizer window from the navigation panel. You will find the navigation panel to the extreme left your screen. \ No newline at end of file From 91dfac25ad1ea5a0042b0f90363e8ac1fab27537 Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Sat, 4 Feb 2023 11:18:55 +0530 Subject: [PATCH 05/31] Update docs/introduction.md Co-authored-by: Alejandra Quetzalli --- docs/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction.md b/docs/introduction.md index 0d65aa9b3..6576664df 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -13,7 +13,7 @@ Studio is a tool to develop AsyncAPI documentation. It allows you to visualize t # Usage -To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) for your API. +To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/create-asyncapi-document#create-AsyncAPI-document) for your API. If you do not have an `asyncapi.yaml` file ready, then generate one by running: From af527dcc1d93469cb20945fecf37323cabccd6e5 Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Sat, 4 Feb 2023 11:19:06 +0530 Subject: [PATCH 06/31] Update docs/README.md Co-authored-by: Alejandra Quetzalli --- docs/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index ade567cd6..358d4f721 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,6 @@ Table of contents - [Introduction](introduction.md) -- [Usage](usage.md) - Navigation - Editor - HTML Preview From c4bcb1fb051f815c1d0c97932e597c133f8fccde Mon Sep 17 00:00:00 2001 From: Jagruti Date: Sat, 4 Feb 2023 11:28:22 +0530 Subject: [PATCH 07/31] fix: updating intro doc based on review --- docs/introduction.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/introduction.md b/docs/introduction.md index c89cf5f9e..cec6b2659 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,4 +1,8 @@ -Studio is a tool to develop AsyncAPI documentation. It allows you to visualize the flow, events, publishers, subscribers as you design your API. +Studio is a tool to develop AsyncAPI documentation. + +Using Studio you can develop an AsyncAPI document, visualize the flow of events, preview, validate, and convert the document to the latest version in one place. + +You can use it to view the events, publishers, subscribers, messages, payload as you design your API. # Studio Use Cases @@ -8,8 +12,10 @@ Studio is a tool to develop AsyncAPI documentation. It allows you to visualize t # Studio Advantages - User-friendly. -- Straightforward and effortless in building APIs. +- Visualizing events flow.. - Interactive AsyncAPI documentation. +- Straightforward and effortless in building APIs. + # Process From a30ac5806303a1b5de1d096ec6b2e2d50849071f Mon Sep 17 00:00:00 2001 From: Jagruti Date: Sat, 4 Feb 2023 11:55:34 +0530 Subject: [PATCH 08/31] fix: updating intro doc based on review --- docs/README.md | 5 +---- docs/introduction.md | 2 +- docs/{usage.md => navigation.md} | 0 3 files changed, 2 insertions(+), 5 deletions(-) rename docs/{usage.md => navigation.md} (100%) diff --git a/docs/README.md b/docs/README.md index 358d4f721..6fc755b23 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,5 @@ Table of contents - [Introduction](introduction.md) -- Navigation -- Editor -- HTML Preview -- Blocks visualizer +- [Navigation](navigation.md) - Studio Settings diff --git a/docs/introduction.md b/docs/introduction.md index 86d4dabab..3a5adc835 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -19,7 +19,7 @@ You can use it to view the events, publishers, subscribers, messages, payload as # Usage -To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/create-asyncapi-document#create-AsyncAPI-document) for your API. +To start using Studio, make sure you have an AsyncAPI file for your API. If you do not have an `asyncapi.yaml` file ready, then generate one by running: diff --git a/docs/usage.md b/docs/navigation.md similarity index 100% rename from docs/usage.md rename to docs/navigation.md From ba9b0dc32ad8c7dcdc92d78bee36e85ceddb9d05 Mon Sep 17 00:00:00 2001 From: Jagruti Date: Sat, 4 Feb 2023 20:36:54 +0530 Subject: [PATCH 09/31] zero draft of navigation.md --- docs/README.md | 2 +- docs/introduction.md | 2 +- docs/navigation.md | 122 +++++++++++++++++++++++++++++++++++++++++++ docs/settings.md | 0 4 files changed, 124 insertions(+), 2 deletions(-) create mode 100644 docs/settings.md diff --git a/docs/README.md b/docs/README.md index 6fc755b23..c4a0e084d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,4 +2,4 @@ Table of contents - [Introduction](introduction.md) - [Navigation](navigation.md) -- Studio Settings +- [Studio Settings](settings.md) diff --git a/docs/introduction.md b/docs/introduction.md index 3a5adc835..f2285176a 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -12,7 +12,7 @@ You can use it to view the events, publishers, subscribers, messages, payload as # Studio Advantages - User-friendly. -- Visualizing events flow.. +- Visualizing events flow. - Interactive AsyncAPI documentation. - Straightforward and effortless in building APIs. diff --git a/docs/navigation.md b/docs/navigation.md index e69de29bb..da99c354e 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -0,0 +1,122 @@ +# Navigation panel + +This guide will walk you through the functions of each button in navigation panel. + +# Navigation Button + +The first button in the navigation panel is the Navigation button. It is one of the default active buttons. + +Navigation button is divided into four parts. It provides the following information: + +- Servers +- Operations +- Messages +- Schemas + +## Servers + +The Servers section displays the name and information of the server you are using to build your AsyncAPI. + +## Operations + +The Operations section lists all the operations that are a part of the AsyncAPI. It adds the perfix `PUB` for publisher and `SUB` for subscriber to differentiate between both the operations. + +## Messages + +This Messages section displays the title of each message used to communicate to the API. + +## Schemas + +The Schemas displays the title of the schemas defined. + + +# Editor + +The Editor section is where you edit the AsyncAPI code. As you edit, you will see the changes reflect dynamically in the HTML preview and Block Visualizer section. + +Click on the individual elements of the Navigation button to jump to those sections in HTML preview and Block Visualizer section. + +## Diagnostics Window + +The Editor also has resizeable Diagnostics window. It shows a quick count of number of errors (in red) and warnings (in yellow) by its title. The description of the warnings and errors with line number is displayed in a table. + +To the right side of the title bar there are three indicators of the Diagnostics window: + +- Valid/Invalid - It is green if the syntax is green and red when invalid. +- Autosave - It shows whether Autosave is on or off. +- Type - Shows the language in which the API is written: `JSON` or `YAML`. + +Bwlow the title bar there is a control panel. You can the buttons to: + +- Hide and show erros +- Hide and show warnings +- Hide and show information messages +- Hide and show hints + +There is also search bar to search that aids in finding issues by their names. You will see Settings icon to the right. It will take you to the governance of Diagnostic window. + +# HTML Preview + +This section displays the preview of everything you have written in the code editor. It uses different fonts, colors, and styles for readability. Each section has a different card. + +It starts with displaying the title, version, description of the API. It renders the formatting too. You can expand each element too see the `key: value` pair of each element, type, payload, and message. + + +# Blocks visualizer + +Blocks visualizer is the USP of this product. It gives you a quick overview of your API. Unlike HTML preview, Blocks visualizer gives a diagrammatic visual of your API. + +Title card is at the top-left corner of the Block visualizer window. Followed by the Operations card. You can visualize channels, published messages, payload, type, patterns, and relationship between the components. + +The Blocks visualizer has two set of controls: + +- In the top right corner of the window you will find the play and reset button. Play to view live relationship between the components and its flow. Reset to get back to the default view. + +- To bottom left of the window there are four controls: zoom in, zoom out, full-screen, toogle interactivity. You zoom the cards in and out or view them in full-screen mode. To prevent the cards from shifting use the toggle interactivity control. + + +# New File + +To create a new file you can pick one of the available templates. + +## Templates + +There are 5 available to quick start Studio. + +- _Simple Example - A basic example of a service that is in charge of processing user signups. Great place to start learning AsyncAPI. + +- Apache Kafka - A framework implementation of a software bus using stream-processing. Open Source developed by the Apache Software Foundation. + +- WebSocket - A framework implementation of a software bus using stream-processing. Open Source developed by the Apache Software Foundation. + +- MQTT - A protocol for fetching resources. It is the foundation of any data exchange on the Web and it is a client-server protocol. + +- HTTP - A protocol for fetching resources. It is the foundation of any data exchange on the Web and it is a client-server protocol. + +## Real World Examples + +Studio provides two real world examples templates to help you get started. + +- Slack Real Time Messaging API - Slack Real time messaging API. Using HTTP protocol. + +- Gitter Streaming API - Gitter Streaming API from https://stream.gitter.im. Using HTTP protocol. + +## Tutorials + +Studio also provides you with a template of an invalid AsyncAPI document. The purpose of this tutorial is to educate, and learn document validation. + +[You can request to add a template](https://github.com/asyncapi/studio/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=Template%20Request:%20{%20template%20name%20and%20type%20}) to the list if you don't find what you are looking for. + + + + + + + + + + + + + + diff --git a/docs/settings.md b/docs/settings.md new file mode 100644 index 000000000..e69de29bb From 600a7361352e00ed6b2c1024a1928339a10bbb6b Mon Sep 17 00:00:00 2001 From: Jagruti Date: Mon, 13 Feb 2023 21:26:36 +0530 Subject: [PATCH 10/31] adding the settings doc --- docs/settings.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/settings.md b/docs/settings.md index e69de29bb..c45b8439f 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -0,0 +1,30 @@ +# Settings + +You will find settings icon in the lower left corner of your screen.It helps you to customize the functioning of the tool to your liking. + +Settings has three tabs: +- Editor +- Governance +- Templates + +## Editor + +Editor allows you to: + +1) Enable or disable the Auto saving mode. +2) Decide the delay in seconds in saving the modified document. + +## Governance + +The Governance tab provides three options: + +1) Enable or disable warning governance issues in the editor's Diagnostics tab. + +2) Enable or disable information governance issues in the editor's Diagnostics tab. + +3) Enable or disable hint governance issues in the editor's Diagnostics tab. + + +## Templates + +Enable or disable the automatic rendering of templates after each change in the document or manually. From 0cc374f47b30007fb311345bfb1c30ffbc5d97fc Mon Sep 17 00:00:00 2001 From: Jagruti Tiwari Date: Mon, 13 Feb 2023 21:42:49 +0530 Subject: [PATCH 11/31] Applying the suggestions based on review. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Maciej Urbańczyk --- docs/navigation.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/navigation.md b/docs/navigation.md index da99c354e..1b3c9abca 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -38,7 +38,12 @@ Click on the individual elements of the Navigation button to jump to those secti ## Diagnostics Window -The Editor also has resizeable Diagnostics window. It shows a quick count of number of errors (in red) and warnings (in yellow) by its title. The description of the warnings and errors with line number is displayed in a table. +The Editor also has resizeable Diagnostics window. It shows a quick count of number of +- errors (in red), +- warnings (in yellow), +- informations (in blue), +- hints (in green) +by its title. The description of the diagnostics with line number is displayed in a table. To the right side of the title bar there are three indicators of the Diagnostics window: @@ -46,14 +51,14 @@ To the right side of the title bar there are three indicators of the Diagnostics - Autosave - It shows whether Autosave is on or off. - Type - Shows the language in which the API is written: `JSON` or `YAML`. -Bwlow the title bar there is a control panel. You can the buttons to: +Below the title bar there is a control panel. You can the buttons to: - Hide and show erros - Hide and show warnings - Hide and show information messages - Hide and show hints -There is also search bar to search that aids in finding issues by their names. You will see Settings icon to the right. It will take you to the governance of Diagnostic window. +There is also search bar to search that aids in finding issues by their names. You will see Settings icon to the right. It will take you to the governance of Diagnostic's settings window. # HTML Preview @@ -83,7 +88,7 @@ To create a new file you can pick one of the available templates. There are 5 available to quick start Studio. -- _Simple Example - A basic example of a service that is in charge of processing user signups. Great place to start learning AsyncAPI. +- Simple Example - A basic example of a service that is in charge of processing user signups. Great place to start learning AsyncAPI. - Apache Kafka - A framework implementation of a software bus using stream-processing. Open Source developed by the Apache Software Foundation. From f80dc2e77398dbf66e75d6dfb629bafcca322385 Mon Sep 17 00:00:00 2001 From: Jagruti Date: Mon, 13 Feb 2023 21:43:18 +0530 Subject: [PATCH 12/31] updating definitions of a few components --- docs/navigation.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/navigation.md b/docs/navigation.md index da99c354e..e1c1b4411 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -23,11 +23,12 @@ The Operations section lists all the operations that are a part of the AsyncAPI. ## Messages -This Messages section displays the title of each message used to communicate to the API. +This Messages section displays the messages stored in `components.messages` section. + ## Schemas -The Schemas displays the title of the schemas defined. +The Schemas displays the schemas stored in the `components.schemas` section. # Editor From 6aa4a0519924ac26144c791bc96a32801869b171 Mon Sep 17 00:00:00 2001 From: Jagruti Date: Tue, 14 Feb 2023 20:13:01 +0530 Subject: [PATCH 13/31] updated the navigation doc --- docs/navigation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/navigation.md b/docs/navigation.md index 226d3fa8d..688a4b83f 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -23,12 +23,12 @@ The Operations section lists all the operations that are a part of the AsyncAPI. ## Messages -This Messages section displays the messages stored in `components.messages` section. +This Messages section displays the messages stored in `components.messages` section. This does not mean that every message in the component is used. It can be defined but it may not used by references in the `operation` field. ## Schemas -The Schemas displays the schemas stored in the `components.schemas` section. +The Schemas displays the schemas stored in the `components.schemas` section. This does not mean that every schema is used in the document. You can have it defined but it may not be used by references in the `message.payload` field. # Editor From 19c4423c9ae795a508a83bedcc409de2d42fb5f1 Mon Sep 17 00:00:00 2001 From: Jagruti Date: Thu, 19 Oct 2023 22:00:01 +0530 Subject: [PATCH 14/31] Modified sentences --- docs/introduction.md | 4 ++-- docs/navigation.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/introduction.md b/docs/introduction.md index f2285176a..7e1146a03 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,4 +1,4 @@ -Studio is a tool to develop AsyncAPI documentation. +Studio is an AsyncAPI development platform that enable users to create, visualise, collaborate on event-driven architectures. Using Studio you can develop an AsyncAPI document, visualize the flow of events, preview, validate, and convert the document to the latest version in one place. @@ -7,7 +7,7 @@ You can use it to view the events, publishers, subscribers, messages, payload as # Studio Use Cases - Create and visualize event-driven AsyncAPI on the go. -- Realtime visualization and documentation for your APIs. +- Real-time visualization and documentation for your APIs. # Studio Advantages diff --git a/docs/navigation.md b/docs/navigation.md index 688a4b83f..57920ecb8 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -33,7 +33,7 @@ The Schemas displays the schemas stored in the `components.schemas` section. Thi # Editor -The Editor section is where you edit the AsyncAPI code. As you edit, you will see the changes reflect dynamically in the HTML preview and Block Visualizer section. +The Editor section is where you edit the AsyncAPI file. As you edit, you will see the changes reflect dynamically in the HTML preview and Block Visualizer section. Click on the individual elements of the Navigation button to jump to those sections in HTML preview and Block Visualizer section. @@ -70,7 +70,7 @@ It starts with displaying the title, version, description of the API. It renders # Blocks visualizer -Blocks visualizer is the USP of this product. It gives you a quick overview of your API. Unlike HTML preview, Blocks visualizer gives a diagrammatic visual of your API. +Blocks visualizer gives you a quick overview of your API. Unlike HTML preview, Blocks visualizer gives a diagrammatic visual of your API. Title card is at the top-left corner of the Block visualizer window. Followed by the Operations card. You can visualize channels, published messages, payload, type, patterns, and relationship between the components. @@ -101,7 +101,7 @@ There are 5 available to quick start Studio. ## Real World Examples -Studio provides two real world examples templates to help you get started. +Studio provides two templates to help you get started. - Slack Real Time Messaging API - Slack Real time messaging API. Using HTTP protocol. From dd3c7e505e931bccb8366b1008cd5ca9e2f6d169 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 28 Nov 2023 10:44:22 +0100 Subject: [PATCH 15/31] Update docs/introduction.md Co-authored-by: Alejandra Quetzalli --- docs/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction.md b/docs/introduction.md index 7e1146a03..c17c076c5 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,6 +1,6 @@ Studio is an AsyncAPI development platform that enable users to create, visualise, collaborate on event-driven architectures. -Using Studio you can develop an AsyncAPI document, visualize the flow of events, preview, validate, and convert the document to the latest version in one place. +Using Studio you can create an AsyncAPI document, visualize the flow of events, preview, validate, and convert the AsyncAPI document to the latest version in one place. You can use it to view the events, publishers, subscribers, messages, payload as you design your API. From 59077662abc01746d63b60792dcf386eb0a8e63b Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 28 Nov 2023 10:44:29 +0100 Subject: [PATCH 16/31] Update docs/navigation.md Co-authored-by: Alejandra Quetzalli --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 57920ecb8..e869358da 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -15,7 +15,7 @@ Navigation button is divided into four parts. It provides the following informat ## Servers -The Servers section displays the name and information of the server you are using to build your AsyncAPI. +The Servers section displays the name and information of the [server]( https://www.asyncapi.com/docs/concepts/server) you are using to build your AsyncAPI. ## Operations From aaa3aba92a85608e3c1cf97ea8feb0650c1b9a99 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 28 Nov 2023 10:44:52 +0100 Subject: [PATCH 17/31] Update docs/navigation.md Co-authored-by: Alejandra Quetzalli --- docs/navigation.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/navigation.md b/docs/navigation.md index e869358da..4adc36cf7 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -112,17 +112,3 @@ Studio provides two templates to help you get started. Studio also provides you with a template of an invalid AsyncAPI document. The purpose of this tutorial is to educate, and learn document validation. [You can request to add a template](https://github.com/asyncapi/studio/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=Template%20Request:%20{%20template%20name%20and%20type%20}) to the list if you don't find what you are looking for. - - - - - - - - - - - - - - From 1a3d7d1cd6fcc40b007c6781406e07a4ae02fc1a Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:21:51 +0100 Subject: [PATCH 18/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 4adc36cf7..6cec72f0c 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -1,6 +1,6 @@ # Navigation panel -This guide will walk you through the functions of each button in navigation panel. +This document will walk you through the functions of each button in the navigation panel. # Navigation Button From 9e186b3958b0c91125c30360421d91febd0d6d12 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:22:06 +0100 Subject: [PATCH 19/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 6cec72f0c..d2b1feefd 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -6,7 +6,7 @@ This document will walk you through the functions of each button in the navigati The first button in the navigation panel is the Navigation button. It is one of the default active buttons. -Navigation button is divided into four parts. It provides the following information: +The navigation button is divided into four parts. It provides the following information: - Servers - Operations From 63d26df49c613f6f381a6df7305fe4156a0b2010 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:22:39 +0100 Subject: [PATCH 20/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index d2b1feefd..6b2c0434f 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -23,7 +23,7 @@ The Operations section lists all the operations that are a part of the AsyncAPI. ## Messages -This Messages section displays the messages stored in `components.messages` section. This does not mean that every message in the component is used. It can be defined but it may not used by references in the `operation` field. +The Messages section displays the messages stored in the `components.messages` section. This does not mean that every message in the component is used. It can be defined but it may not used by references in the `operation` field. ## Schemas From 57cb82d5ac66a9a06f550b1227c1250f6af5f3dd Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:22:55 +0100 Subject: [PATCH 21/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 6b2c0434f..6ced79ff3 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -39,7 +39,7 @@ Click on the individual elements of the Navigation button to jump to those secti ## Diagnostics Window -The Editor also has resizeable Diagnostics window. It shows a quick count of number of +The Editor also has a resizeable Diagnostics window. It shows a quick count number of... - errors (in red), - warnings (in yellow), - informations (in blue), From 136c0dec88a6d7d63c24336f6b287cecfe32c10b Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:23:14 +0100 Subject: [PATCH 22/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 6ced79ff3..3bef537f3 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -42,7 +42,7 @@ Click on the individual elements of the Navigation button to jump to those secti The Editor also has a resizeable Diagnostics window. It shows a quick count number of... - errors (in red), - warnings (in yellow), -- informations (in blue), +- information (in blue), - hints (in green) by its title. The description of the diagnostics with line number is displayed in a table. From 99c23cf77c0492f42db864e5c33c30abd5297f20 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:24:17 +0100 Subject: [PATCH 23/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 3bef537f3..3926e6bd1 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -44,7 +44,7 @@ The Editor also has a resizeable Diagnostics window. It shows a quick count numb - warnings (in yellow), - information (in blue), - hints (in green) -by its title. The description of the diagnostics with line number is displayed in a table. +...by its title. The description of the diagnostics with line number is displayed in a table. To the right side of the title bar there are three indicators of the Diagnostics window: From 79a87bdf8c82b163814007bb0eabad979c94cc81 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:24:27 +0100 Subject: [PATCH 24/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 3926e6bd1..711da46f3 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -52,7 +52,7 @@ To the right side of the title bar there are three indicators of the Diagnostics - Autosave - It shows whether Autosave is on or off. - Type - Shows the language in which the API is written: `JSON` or `YAML`. -Below the title bar there is a control panel. You can the buttons to: +Below the title bar there is a control panel. You can use the buttons to: - Hide and show erros - Hide and show warnings From c1aff6f284dea168c808f7d5ed61b272646bcc60 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:24:48 +0100 Subject: [PATCH 25/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 711da46f3..3b311d238 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -59,7 +59,7 @@ Below the title bar there is a control panel. You can use the buttons to: - Hide and show information messages - Hide and show hints -There is also search bar to search that aids in finding issues by their names. You will see Settings icon to the right. It will take you to the governance of Diagnostic's settings window. +There is also a search bar that aids in finding issues by their names. You will see the Settings icon to the right. It will take you to the governance of Diagnostic's settings window. # HTML Preview From bea607009d877d9a59b66661cb46f0bc4d483a69 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:25:02 +0100 Subject: [PATCH 26/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 3b311d238..099c6f245 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -65,7 +65,7 @@ There is also a search bar that aids in finding issues by their names. You will This section displays the preview of everything you have written in the code editor. It uses different fonts, colors, and styles for readability. Each section has a different card. -It starts with displaying the title, version, description of the API. It renders the formatting too. You can expand each element too see the `key: value` pair of each element, type, payload, and message. +It starts with displaying the title, version, and description of the API. It renders the formatting too. You can expand each element too via the `key: value` pair of each element, type, payload, and message. # Blocks visualizer From ac6a5b980e7c07c3c76b42bdac1f747282214b9e Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:25:19 +0100 Subject: [PATCH 27/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 099c6f245..3c558c782 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -72,7 +72,7 @@ It starts with displaying the title, version, and description of the API. It ren Blocks visualizer gives you a quick overview of your API. Unlike HTML preview, Blocks visualizer gives a diagrammatic visual of your API. -Title card is at the top-left corner of the Block visualizer window. Followed by the Operations card. You can visualize channels, published messages, payload, type, patterns, and relationship between the components. +The title card is at the top-left corner of the Block visualizer window. Followed by the Operations card. You can visualize channels, published messages, payload, type, patterns, and relationships between the components. The Blocks visualizer has two set of controls: From 6c244e5b22a3acaa1dbbc7ce3209fb25b6e99d40 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:25:34 +0100 Subject: [PATCH 28/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 3c558c782..4e133e63a 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -78,7 +78,7 @@ The Blocks visualizer has two set of controls: - In the top right corner of the window you will find the play and reset button. Play to view live relationship between the components and its flow. Reset to get back to the default view. -- To bottom left of the window there are four controls: zoom in, zoom out, full-screen, toogle interactivity. You zoom the cards in and out or view them in full-screen mode. To prevent the cards from shifting use the toggle interactivity control. +- To the bottom left of the window there are four controls: zoom in, zoom out, full-screen, and toogle interactivity. You zoom the cards in and out or view them in full-screen mode. To prevent the cards from shifting use the toggle interactivity control. # New File From d065f5404f551eb4113237be4d10e77370a19639 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:25:46 +0100 Subject: [PATCH 29/31] Update docs/navigation.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/navigation.md b/docs/navigation.md index 4e133e63a..240df1d33 100644 --- a/docs/navigation.md +++ b/docs/navigation.md @@ -111,4 +111,4 @@ Studio provides two templates to help you get started. Studio also provides you with a template of an invalid AsyncAPI document. The purpose of this tutorial is to educate, and learn document validation. -[You can request to add a template](https://github.com/asyncapi/studio/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=Template%20Request:%20{%20template%20name%20and%20type%20}) to the list if you don't find what you are looking for. +[You can request to add a Studio template](https://github.com/asyncapi/studio/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=Template%20Request:%20{%20template%20name%20and%20type%20}) to the list if you don't find what you are looking for. From f304b6c5c6fce7a627d299e767326fd6da38b5f0 Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:25:57 +0100 Subject: [PATCH 30/31] Update docs/settings.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings.md b/docs/settings.md index c45b8439f..9379bbf3d 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -1,6 +1,6 @@ # Settings -You will find settings icon in the lower left corner of your screen.It helps you to customize the functioning of the tool to your liking. +You will find the settings icon in the lower-left corner of your screen. It helps you to customize tool functioning to your liking. Settings has three tabs: - Editor From c1f6de550d698c821bf696e6fa88fd57e16019da Mon Sep 17 00:00:00 2001 From: samz Date: Tue, 26 Mar 2024 21:26:30 +0100 Subject: [PATCH 31/31] Update docs/settings.md Co-authored-by: Quetzalli <19964402+alequetzalli@users.noreply.github.com> --- docs/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings.md b/docs/settings.md index 9379bbf3d..0c5fe97f6 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -9,7 +9,7 @@ Settings has three tabs: ## Editor -Editor allows you to: +The editor allows you to: 1) Enable or disable the Auto saving mode. 2) Decide the delay in seconds in saving the modified document.