feat: show operation summary on sidebar

[sarisia]

Description

Prior to @asyncapi/[email protected],
operations' summary is shown in sidebar but current version does not:

(code from v0.20.1)

https://github.com/asyncapi/html-template/blob/d2c4513eef9b33bfc977ed5ed92eb188e8988b62/partials/sidebar.html#L50-L58

Changes proposed in this pull request:

• if operation has a summary, show it on sidebar

Current behavior

Updated behavior

Related issue(s)

[github-actions]

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[magicmatatjahu]

@sarisia Thanks for PR! Looks great, however, I suggest to display with summary also channel name to identify which channel is described, like {channelName} {optionalSummary}.

[sarisia]

@magicmatatjahu Thank you for reviewing and sorry for my late response.

I think adding channel name to sidebar makes the line length too long and users may feel hard to find
operations at a grance.

At Redoc (OpenAPI docs generator) they only show summary
on sidebars for years , so I think it's enough to do so.

What do you think?

[magicmatatjahu]

@sarisia I would also prefer to add the name of the channel. Here is what it looks like for example.

WDYT?

[github-actions]

This pull request 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 pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request 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 pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[magicmatatjahu]

@sarisia Thanks for contribution!

[asyncapi-bot]

🎉 This PR is included in version 1.0.0-next.46 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[sarisia]

#595 (comment)
@sarisia I would also prefer to add the name of the channel. Here is what it looks like for example.

WDYT?

Sorry for not responding for a long time.

Maybe make it controllable by sidebar option is better, but since I'm not the React guy, it may take some time to make PR...

Maybe I'll create an new follow up issue later. Thanks!

[magicmatatjahu]

@sarisia No problem! Yeah, it can be :) Please create issue and I will make PR. I would like to close as many issues as possible in the next few days/weeks, because later I will not have time to do it.

[sarisia]

@magicmatatjahu #701, thanks!

[shanewazabbas]

I don't like this change. If a summary is really long, it makes the sidebar look like a mess...

[sarisia]

If a summary is really long, it makes the sidebar look like a mess...

Indeed. We had same problem for very long channel name.

#701 suggests adding sidebar option to change the priority between channelName and summary.