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

Add the option of Generating docs in the main section #1104

Open
AayushSaini101 opened this issue May 28, 2024 · 22 comments
Open

Add the option of Generating docs in the main section #1104

AayushSaini101 opened this issue May 28, 2024 · 22 comments
Assignees
Labels
bounty AsyncAPI Bounty enhancement New feature or request

Comments

@AayushSaini101
Copy link

Reference: https://editor.swagger.io/ the Generator code section is present on the main screen, where as the in asyncapi studio devleoper need to click on three dots then need to click Generate doc/code.

For the easy accessiblity and increase the developer experience the generate code/docs option must be present in the main tab.

image image
@KhudaDad414
Copy link
Member

Totally, I think we should create some icons for those options and then show the current options as a tooltip.

@AayushSaini101
Copy link
Author

Totally, I think we should create some icons for those options and then show the current options as a tooltip.

Do we need for all options ?

@KhudaDad414
Copy link
Member

@AayushSaini101 not sure if we can come up with an icon for each one, but it is easier to create four icons for each category and show a dropdown of those relevent options.

  1. import icon.
    a) import from file
    b) import from url
    c) import from base64
  2. save icon:
    a) save as yaml
    b) save as JSON
  3. convert icon:
    a) convert to json/yaml
    b) convert to another AsyncAPI version
  4. generate code/doc icon

@abhavgoel
Copy link

@AayushSaini101 @KhudaDad414 should the the three dots be removed completely from the editor page?

@KhudaDad414
Copy link
Member

@abhavgoel yep. After we show the options in categories then nothing will remain for the the overflow menu.

Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Nov 28, 2024
@ShashwatPS
Copy link

@KhudaDad414 You mean something like this ?

Screen.Recording.2025-01-04.at.11.29.25.AM.mov

If this is good enough, i can remove the borders which are there in the generate section and make a PR.

@github-actions github-actions bot removed the stale label Jan 5, 2025
@AayushSaini101
Copy link
Author

@KhudaDad414 You mean something like this ?

Screen.Recording.2025-01-04.at.11.29.25.AM.mov
If this is good enough, i can remove the borders which are there in the generate section and make a PR.

@ShashwatPS feel free to create a PR on this if you want thanks

@AayushSaini101
Copy link
Author

AayushSaini101 commented Mar 7, 2025

Submitted for bounty issue, i will take this

@aeworxet
Copy link
Contributor

Bounty Issue's service comment

Text labels: bounty/2025-Q2, bounty/medium, bounty/coding
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.

@asyncapi-bot asyncapi-bot added the bounty AsyncAPI Bounty label Mar 17, 2025
@abhavgoel
Copy link

Image

How about adding it on Side bar, as this is the core functionality?

@abhavgoel
Copy link

Hi @AayushSaini101, the original issue states that the "Generate code/docs", should be in the main bar (I assumed you meant the side bar if I am not wrong).

  • @KhudaDad414 commented that we can categorize all such options. Lets finalize an approach and I'll start working on this.

Current PR adds the Generate code/docs option in the side bar. Also clarify what you meant by the main bar here.

@Shurtu-gal
Copy link
Collaborator

@abhavgoel this is a bounty issue please wait until you are assigned before moving forward.

@Shurtu-gal
Copy link
Collaborator

I am assigning @abhavgoel to this issue.

The deliverables include:

  • Putting the icons similar to the screen recording. So that all options are on the bar atop the editor.
  • Ensuring generator and other options is working properly

@abhavgoel
Copy link

Should the options also be categorized as shown in the recording?

@AayushSaini101
Copy link
Author

Should the options also be categorized as shown in the recording?

yes, take the reference of the screen recording, https://editor.swagger.io/ reference this will help to enhance to user experience on the studio

@aeworxet
Copy link
Contributor

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
Medium 2025-03-21 2025-04-07 2025-05-18 2025-04-20 2025-05-04 2025-05-18
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: @abhavgoel (githubID: 72388884)

@aeworxet aeworxet moved this to In Progress in Bounty Program Mar 21, 2025
@abhavgoel
Copy link

Approach after code analysis -

  • I plan to make 4 files each for different dropdown category (Import, Generate etc.) and move the code in them, so that they wont clutter the main file.

@abhavgoel
Copy link

Screen.Recording.2025-03-24.at.11.32.09.PM.mov

@AayushSaini101 @Shurtu-gal does this look good?

@abhavgoel
Copy link

Can I raise a PR now, or according to the start date in the above comment?

@aeworxet
Copy link
Contributor

@abhavgoel

Can I raise a PR now, or according to the start date in the above comment?

Yes, the expedited procedure is welcomed.

@Shurtu-gal
Copy link
Collaborator

@abhavgoel no need to worry regarding generator of server-api not working for v3.0.0. Just go ahead and start working on adding the test suites. I will fix the api at the earliest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty AsyncAPI Bounty enhancement New feature or request
Projects
Status: In Progress
Status: Backlog
Development

Successfully merging a pull request may close this issue.

7 participants