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

Consolidate the JSON and YAML examples in the specs into one codeblock to reduce the readers scroll effort #1067

Open
nikhilkalburgi opened this issue Sep 9, 2024 · 2 comments
Labels
💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md)

Comments

@nikhilkalburgi
Copy link

Description:

Currently, the examples in the specs are shown in two variants (JSON and YAML) and displayed vertically one below the other. This increases the scrolling effort of the readers.

Reproduce by navigating to https://www.asyncapi.com/docs/reference/specification/v3.0.0#specification

Proposal:

To reduce this effort, I propose to combine the examples in a single block each and let the readers decide to choose between JSON or YAML by building tabs right above the example code block.

Screenshots: Change highlighted in red

image

@nikhilkalburgi nikhilkalburgi added the 💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) label Sep 9, 2024
Copy link

github-actions bot commented Sep 9, 2024

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

@AaryaBalwadkar
Copy link

AaryaBalwadkar commented Nov 17, 2024

I also feel same. This issue is website related right? So, we need to make changes in asyncapi/website repository, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md)
Projects
None yet
Development

No branches or pull requests

2 participants