Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added table of contents and introduction document for Studio tool #553

Open
wants to merge 46 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
2587e35
doc: added the introduction document
Jagrutiti Jan 29, 2023
addb6bf
Update docs/introduction.md
Jagrutiti Feb 2, 2023
226f726
Update docs/introduction.md
Jagrutiti Feb 4, 2023
12ac0ea
Update docs/introduction.md
Jagrutiti Feb 4, 2023
91dfac2
Update docs/introduction.md
Jagrutiti Feb 4, 2023
af527dc
Update docs/README.md
Jagrutiti Feb 4, 2023
c4bcb1f
fix: updating intro doc based on review
Jagrutiti Feb 4, 2023
f0121e7
Merge branch 'doc/introduction' of https://github.com/Jagrutiti/studi…
Jagrutiti Feb 4, 2023
a30ac58
fix: updating intro doc based on review
Jagrutiti Feb 4, 2023
ba9b0dc
zero draft of navigation.md
Jagrutiti Feb 4, 2023
b3ca964
Merge branch 'master' into doc/introduction
magicmatatjahu Feb 13, 2023
600a736
adding the settings doc
Jagrutiti Feb 13, 2023
a51456e
Merge branch 'doc/introduction' of https://github.com/Jagrutiti/studi…
Jagrutiti Feb 13, 2023
0cc374f
Applying the suggestions based on review.
Jagrutiti Feb 13, 2023
f80dc2e
updating definitions of a few components
Jagrutiti Feb 13, 2023
619ac02
Merge branch 'doc/introduction' of https://github.com/Jagrutiti/studi…
Jagrutiti Feb 13, 2023
6aa4a05
updated the navigation doc
Jagrutiti Feb 14, 2023
26a14ec
Merge branch 'master' into doc/introduction
KhudaDad414 Sep 26, 2023
8def3f9
Merge branch 'asyncapi:master' into doc/introduction
Jagrutiti Oct 19, 2023
19c4423
Modified sentences
Jagrutiti Oct 19, 2023
e64d6c5
Merge branch 'master' into doc/introduction
Amzani Oct 27, 2023
dd3c7e5
Update docs/introduction.md
Amzani Nov 28, 2023
5907766
Update docs/navigation.md
Amzani Nov 28, 2023
aaa3aba
Update docs/navigation.md
Amzani Nov 28, 2023
40624b1
Merge branch 'master' into doc/introduction
Amzani Feb 16, 2024
b9e8fe6
Merge branch 'master' into doc/introduction
Amzani Feb 19, 2024
ae25d3c
Merge branch 'master' into doc/introduction
Amzani Feb 19, 2024
26a0958
Merge branch 'master' into doc/introduction
Amzani Feb 21, 2024
7643f0c
Merge branch 'master' into doc/introduction
Amzani Mar 18, 2024
48fc8fa
Merge branch 'master' into doc/introduction
Amzani Mar 26, 2024
1a3d7d1
Update docs/navigation.md
Amzani Mar 26, 2024
9e186b3
Update docs/navigation.md
Amzani Mar 26, 2024
63d26df
Update docs/navigation.md
Amzani Mar 26, 2024
57cb82d
Update docs/navigation.md
Amzani Mar 26, 2024
136c0de
Update docs/navigation.md
Amzani Mar 26, 2024
99c23cf
Update docs/navigation.md
Amzani Mar 26, 2024
79a87bd
Update docs/navigation.md
Amzani Mar 26, 2024
c1aff6f
Update docs/navigation.md
Amzani Mar 26, 2024
bea6070
Update docs/navigation.md
Amzani Mar 26, 2024
ac6a5b9
Update docs/navigation.md
Amzani Mar 26, 2024
6c244e5
Update docs/navigation.md
Amzani Mar 26, 2024
d065f54
Update docs/navigation.md
Amzani Mar 26, 2024
f304b6c
Update docs/settings.md
Amzani Mar 26, 2024
c1f6de5
Update docs/settings.md
Amzani Mar 26, 2024
ccbb96c
Merge branch 'master' into doc/introduction
KhudaDad414 Mar 26, 2024
c470434
Merge branch 'master' into doc/introduction
KhudaDad414 Apr 4, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Table of contents
Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved

- [Introduction](introduction.md)
- [Usage](usage.md)
Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved
- Navigation
- Editor
- HTML Preview
- Blocks visualizer
- Studio Settings
18 changes: 18 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -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.

Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved
# Studio Use Cases

- Create and visualize event-driven AsyncAPI on the go.
- Realtime visualization and documentation for your APIs.
KhudaDad414 marked this conversation as resolved.
Show resolved Hide resolved


# Studio Advantages
- User-friendly.
- Straightforward and effortless in building APIs.
- Interactive AsyncAPI documentation.

Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved
# Process
Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved

To start using Studio, [create an AsyncAPI file](https://www.asyncapi.com/docs/tutorials/streetlights#creating-the-asyncapi-file) for your API.
Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved

Jagrutiti marked this conversation as resolved.
Show resolved Hide resolved
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.
Empty file added docs/usage.md
Empty file.