Skip to content

docs: add onboarding and thorough documentation for studio #4107

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

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

TRohit20
Copy link
Collaborator

@TRohit20 TRohit20 commented May 9, 2025

Description

The PR intends to introduce a set of documents for AsyncAPI Studio, aimed at enhancing user understanding and facilitating easier contributions.

The documentation covers multiple aspects such as installation, usage, and architecture.

Related issue(s)
Resolves the following bounty issue: asyncapi/studio#1169

Summary by CodeRabbit

  • Documentation
    • Added a new AsyncAPI Studio section with overview, architecture, installation, and usage guides.
    • Documentation highlights key features, interface elements, deployment methods, code generation, collaboration, keyboard shortcuts, best practices, and troubleshooting.

Copy link
Contributor

coderabbitai bot commented May 9, 2025

Walkthrough

Several new documentation files were added under the Studio section, providing an overview, installation instructions, architecture details, and a usage guide for AsyncAPI Studio. A metadata file was also introduced to organize the section within the documentation structure. No code or exported entities were altered.

Changes

File(s) Change Summary
markdown/docs/tools/studio/_section.md Added a metadata file defining the "Studio" section with a title and ordering weight for documentation organization.
markdown/docs/tools/studio/index.md Introduced an "Introduction" page for AsyncAPI Studio, outlining its features, core functionalities, and a high-level architecture diagram using Mermaid.
markdown/docs/tools/studio/architecture.md Added a detailed architecture document describing AsyncAPI Studio’s modular monorepo structure, layered architecture, technology stack, data flow, deployment options, and key design decisions.
markdown/docs/tools/studio/installation.md Added an installation guide covering online usage, local installation (Node.js, Docker, CLI), building from source, and system requirements.
markdown/docs/tools/studio/usage.md Added a comprehensive usage guide detailing the interface, document creation, editing, validation, version conversion, preview, visualization, code generation, sharing, keyboard shortcuts, best practices, and troubleshooting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant EditorService
    participant ParserService
    participant NavigationService
    participant MonacoEditor
    participant AsyncAPIParser
    participant ReactFlow
    participant AsyncAPIReact

    User->>UI: Interacts (edit, navigate, preview)
    UI->>EditorService: Sends edit actions
    EditorService->>MonacoEditor: Updates content
    EditorService->>ParserService: Triggers validation/parsing
    ParserService->>AsyncAPIParser: Parse & validate AsyncAPI document
    ParserService-->>UI: Returns validation results
    UI->>NavigationService: Updates navigation state
    UI->>ReactFlow: Updates visual flow diagram
    UI->>AsyncAPIReact: Updates documentation preview
Loading

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • VaishnaviNandakumar
  • asyncapi-bot-eve

Poem

In Studio’s warren, new docs now appear,
With guides and diagrams, the path is clear.
From install to usage, the journey’s mapped out,
Architecture explained—no need to doubt!
📝🐇 A rabbit’s delight, so hop right in,
Explore AsyncAPI Studio, let your learning begin!

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 268dab1 and bbaf4a8.

📒 Files selected for processing (1)
  • markdown/docs/tools/studio/architecture.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • markdown/docs/tools/studio/architecture.md
⏰ Context from checks skipped due to timeout of 180000ms (1)
  • GitHub Check: Test NodeJS PR - macos-13

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented May 9, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 8794150
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/6822a54e1bb20e0008d48dea
😎 Deploy Preview https://deploy-preview-4107--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@TRohit20 TRohit20 marked this pull request as ready for review May 9, 2025 17:07
Copy link

codecov bot commented May 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7efaf9f) to head (8794150).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4107   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          778       778           
  Branches       144       144           
=========================================
  Hits           778       778           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
markdown/docs/tools/studio/installation.md (1)

43-45: Specify language for the plain URL code block
For consistency, add a language identifier (e.g., plaintext) to the code fence for the URL snippet:

- ```
- http://localhost:3000
- ```
+ ```plaintext
+ http://localhost:3000
+ ```

This enhances uniformity in code block rendering.

markdown/docs/tools/studio/usage.md (1)

75-75: Add missing period for consistency
The list item should end with a period:

- 4. The preview updates automatically as you edit your document
+ 4. The preview updates automatically as you edit your document.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~75-~75: A period might be missing here.
Context: ... updates automatically as you edit your document ## Visualizing Your API To visualize ...

(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7491398 and 5a5cfb4.

📒 Files selected for processing (5)
  • markdown/docs/tools/studio/_section.md (1 hunks)
  • markdown/docs/tools/studio/architecture.md (1 hunks)
  • markdown/docs/tools/studio/index.md (1 hunks)
  • markdown/docs/tools/studio/installation.md (1 hunks)
  • markdown/docs/tools/studio/usage.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
markdown/docs/tools/studio/usage.md

[uncategorized] ~75-~75: A period might be missing here.
Context: ... updates automatically as you edit your document ## Visualizing Your API To visualize ...

(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)

⏰ Context from checks skipped due to timeout of 180000ms (4)
  • GitHub Check: Redirect rules - asyncapi-website
  • GitHub Check: Header rules - asyncapi-website
  • GitHub Check: Pages changed - asyncapi-website
  • GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (7)
markdown/docs/tools/studio/_section.md (1)

1-4: Correct front-matter for section metadata
The title and weight values are properly configured to define and order the Studio section within the documentation.

markdown/docs/tools/studio/installation.md (2)

1-4: Front-matter is correct
The title and weight properly classify this as the Installation Guide page within the Studio section.


100-112: Verify relative path to AsyncAPI CLI docs
The link ../cli/ should point to the correct CLI documentation in the MkDocs structure. Please confirm it resolves as expected.

markdown/docs/tools/studio/index.md (1)

1-4: Front-matter is well-defined
The title and weight accurately place this introduction page at the start of the Studio section.

markdown/docs/tools/studio/usage.md (1)

1-4: Front-matter is correctly configured
The title and weight align with its position in the Studio section (packed after Installation).

markdown/docs/tools/studio/architecture.md (2)

1-4: Front-matter is accurate
The title and weight correctly place this architecture overview as the last page in the Studio section.


8-34: Mermaid diagrams are properly fenced
All Mermaid diagrams in this document have matching opening and closing fences, ensuring they render correctly.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
markdown/docs/tools/studio/architecture.md (2)

1-4: Enhance frontmatter with description field
Adding a description key in frontmatter improves SEO, consistency, and provides a summary for other tools (e.g., search indexing).

Proposed diff:

--- a/markdown/docs/tools/studio/architecture.md
+++ b/markdown/docs/tools/studio/architecture.md
@@
 ---
 title: 'Architecture'
+description: >-
+  Detailed architectural overview of AsyncAPI Studio, including its layered
+  design, core services, components, data flow, and deployment options.
 weight: 50
 ---

100-100: Clarify hierarchy of "State Management"
Since State Management is part of the Services Layer, consider demoting it to an #### sub-heading or nesting it under the Services Layer section for clearer structure.

-### State Management
+#### State Management
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 090fd6b and 268dab1.

📒 Files selected for processing (1)
  • markdown/docs/tools/studio/architecture.md (1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (1)
  • GitHub Check: Test NodeJS PR - macos-13

@Shurtu-gal
Copy link
Contributor

Couple of things:

  1. Usage using descriptive images would be better in my opinion.
  2. Perhaps need to split up usage into separate .md files for each use-case with a little more detail:
    • Generation of docs from code itself in studio
    • Validation of spec
    • Usage of preview pane on right on two modes (template preview and blocks visualiser)
    • Sharing of specs (and how data is stored)
    • Use of diagnostics terminal on bottom.

Tagging maintainers: @Amzani (Can add more if needed)
Bounty responsibility: @AayushSaini101

@TRohit20
Copy link
Collaborator Author

TRohit20 commented May 9, 2025

@Shurtu-gal should I go ahead and implement those changes then ? But If we do that, usage doc gets much shorter and each document would be a separate document per use by itself.

@Shurtu-gal
Copy link
Contributor

I suppose we can start with that, if the doc is too short we can merge them.

@TRohit20
Copy link
Collaborator Author

TRohit20 commented May 9, 2025

@Shurtu-gal But my concern is, if we go with separate docs per use case, we will need to create a sub topic for usage and write the multiple docs under it, which would essentially overlap with guides purview? so how do you suggest we construct the IA in this case?

Based on IA best practises and other tool documentation, we don’t usually add descriptive images and stuff, we keep it very simple and intuitive as it is as of now.

Plus, I feel like we would be making it complex or divided at the moment, do we really wanna go there now? we can work towards the separation and to-do API tutorial iteratively going forward.

WDYT @Amzani @AayushSaini101

@asyncapi-bot asyncapi-bot added the bounty AsyncAPI Bounty program related label label May 10, 2025
@aeworxet
Copy link
Contributor

@asyncapi/bounty_team

@aeworxet aeworxet moved this to In Progress in Bounty Program May 10, 2025
@TRohit20
Copy link
Collaborator Author

Following up to see what @AayushSaini101 & @Amzani have to suggest to take it forward ACC. or review please ?

@AayushSaini101
Copy link

, we will need to cre

What about splitting the docs itself in multiple section @TRohit20 ?

@AayushSaini101
Copy link

image
Example

@TRohit20
Copy link
Collaborator Author

we can but it would make it overlap and little complex maybe. but I am willing work with the suggestion, how do you suggest I break it up, I will have the changes pushed acc @AayushSaini101

@AayushSaini101
Copy link

we can but it would make it overlap and little complex maybe. but I am willing work with the suggestion, how do you suggest I break it up, I will have the changes pushed acc @AayushSaini101

@TRohit20 could you share structure how you are thinking to implement ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty AsyncAPI Bounty program related label
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

5 participants