[Docs] Onboarding documentation for the Studio

[AayushSaini101]

Need to onboard proper documentation for the studio, at present no documentation is present for the studio. Good for onboarding new folks to get clear idea about the tool

[AayushSaini101]

Submitted for bounty program, I will take this

[aeworxet]

Bounty Issue's service comment

Text labels: bounty/2025-Q2, bounty/advanced, bounty/docs
First assignment to regular contributors: 2025-03-21 00:00:00 UTC+12:00
End Of Life after: 2025-04-30 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.

Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

[AayushSaini101]

@aeworxet @Shurtu-gal I would like to work on this issue :)

[Shurtu-gal]

@aeworxet @Shurtu-gal I would like to work on this issue :)

Only two issues can be taken up if I am not wrong @aeworxet

[hxrshxz]

I would like to ? work on this issue could you please assign it to me ? @Shurtu-gal @aeworxet kindly let me know 😅

[aeworxet]

@Shurtu-gal

Only two, and @AayushSaini101 already has two assigned:

• [FEATURE] Add Command-line Tab Completion to AsyncAPI CLI cli#1685
• Parallel execution command asyncapi generate got error cli#814

[AayushSaini101]

@Shurtu-gal

Only two, and @AayushSaini101 already has two assigned:

• [FEATURE] Add Command-line Tab Completion to AsyncAPI CLI cli#1685
• Parallel execution command asyncapi generate got error cli#814

can i take this, after completing one issue, i have already created a PR for one issue
My pr is also ready for this issue I didn't know the rules before of the bounty rules . I will take care in future 🙏🏻@aeworxet

[aeworxet]

@AayushSaini101

Please do not exhibit the behavior you were demonstrating before becoming a maintainer. You were not supposed to start working on an issue that was not assigned to you in the first place.
This Bounty Issue is free for assignment.

[AayushSaini101]

@AayushSaini101

Please do not exhibit the behavior you were demonstrating before becoming a maintainer. You were not supposed to start working on an issue that was not assigned to you in the first place. This Bounty Issue is free for assignment.

Thanks we can assign this issue to the appropriate person.

[hxrshxz]

Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

For this to be assigned to me Can I propose how I plan to work on this issue directly in the GitHub comment, or should I do it on Slack? do let me know. , I am new to AsyncAPI's bounty program , also it should be done after 21st march? right thank you

[AayushSaini101]

Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

For this to be assigned to me Can I propose how I plan to work on this issue directly in the GitHub comment, or should I do it on Slack? do let me know. , I am new to AsyncAPI's bounty program , also it should be done after 21st march? right thank you

I guess you should have some previous contributions to start with bounty issue. Kindly check rules thanks

[aeworxet]

@AayushSaini101

The final decision is up to this repository's maintainer, who is @Shurtu-gal.

[Shurtu-gal]

For this to be assigned to me Can I propose how I plan to work on this issue directly in the GitHub comment, or should I do it on Slack? do let me know. , I am new to AsyncAPI's bounty program , also it should be done after 21st march? right thank you

Anybody and everybody are free to submit their proposals here, but selection would be done based on priority

Important

Also to make it clear, this would be a humongous task and would require ample information on both Studio workings and technical write-manship (as this is not a mentorship).

PS: I would advise you to read through the bounty rules once, everything is clearly mentioned there.

[jerensl]

Proposal for Creating Onboarding Documentation

Effective onboarding is critical to ensuring new contributors integrate seamlessly into the project and become productive as quickly as possible. This proposal outlines the need for structured onboarding documentation to streamline the onboarding process and improve overall efficiency.

Objective

The primary objective of this initiative is to create a comprehensive onboarding guide that provides clear instructions, expectations, and resources for new contributors. The documentation will serve as a central reference to:

• Reduce the time required for new contributor to become productive.
• Standardize the onboarding process.
• Minimize disruptions to existing team members.
• Improve engagement and retention.

Scope of Work

The onboarding documentation will include:

1. Minimum Requirements & Dependencies

• System prerequisites
• Necessary tools and installations
• Environment setup guidelines

2. Repository Setup

• Cloning the repository
• Working with the PNPM workspace
• Running the server locally or via Docker

3. Contributing Guidelines

• Standardizing commit messages using Commitlint
• Best practices for submitting pull requests
• Code review process and expectations

4. Architecture & Documentation

• Recording Architecture Decision Records (ADR) for tracking architectural changes
• Maintaining project documentation and design decisions

5. Release Process

• Adding and managing changesets

By implementing this structured onboarding documentation, we aim to create a seamless experience for new contributors while optimizing the team's efficiency and collaboration.

Feel free to suggest any additions if I missed something. I'll make updates as needed later.

[Shurtu-gal]

Please align your viewpoint according to end user. Documentation on website is not for contributors rather it is for the ones using the tools I believe.

[jerensl]

I propose writing a tutorial for a to-do API that intentionally includes incorrect assertions, guiding users through debugging to complement the existing onboarding already added in the studio. I will also follow the Divio documentation system's tutorial guidelines while working on the documentation.

[TRohit20]

@Shurtu-gal & @AayushSaini101 you can assign the issue to me, I'll gather the relevant context through KT from either of you and carry it out. Thank you! :)

[Shurtu-gal]

As @TRohit20 being a maintainer comes under Priority #1. I am assigning the issue to him.

[aeworxet]

Bounty Issue's Timeline

Complexity Level	Assignment Date (by GitHub)	Start Date (by BP Rules)	End Date (by BP Rules)	Draft PR Submission	Final PR Merge Start	Final PR Merge End
Advanced	2025-03-20	2025-04-07	2025-06-01	2025-04-27	2025-05-18	2025-06-01

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

Keep in mind the responsibility for violations of the Timeline.

Assignee: @TRohit20 (githubID: 108233235)