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

Provide a better visualization for collapsing long blocks of code/output #5405

Open
svrnm opened this issue Oct 15, 2024 · 4 comments
Open
Labels
outreachy Issues for Outreachy Participants ux

Comments

@svrnm
Copy link
Member

svrnm commented Oct 15, 2024

We are currently using <details> and <summary> to wrap long code blocks or text outputs. An example can be seen here:

Code: https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/languages/js/getting-started/nodejs.md?plain=1#L254
Output: https://opentelemetry.io/docs/languages/js/getting-started/nodejs/#run-the-instrumented-app

Screenshot:
Screenshot 2024-10-15 at 12 21 45

This is really hard to see and easily overseen when someone scrolls through the page, especially when they are looking for the expected output or a code snippet.

It would be great to have a better visualization, e.g. the first few lines are shown but the rest is hidden away with an "unfold" button. There are plenty of options, but it would be good to have something that makes it visually clear that there is something behind that "tiny arrow"

Special Note for Outreachy Contributors: if you want to work on this issue, please make sure that you have completed the small steps and at least one assigned issue as outlined here: #5290

@svrnm svrnm added ux outreachy Issues for Outreachy Participants labels Oct 15, 2024
@kemsguy7
Copy link

@svrnm , can you please assign this to me?

@svrnm
Copy link
Member Author

svrnm commented Oct 15, 2024

@svrnm , can you please assign this to me?

Let's finish #5403 first, then you can work on this one

@kemsguy7
Copy link

@svrnm , can you please assign this to me?

Let's finish #5403 first, then you can work on this one

Please can i work on this now?

@svrnm
Copy link
Member Author

svrnm commented Oct 16, 2024

@svrnm , can you please assign this to me?

Let's finish #5403 first, then you can work on this one

Please can i work on this now?

Yes! I suggest you start by making some suggestions how you would implement that or what ideas you have to address the issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
outreachy Issues for Outreachy Participants ux
Projects
Status: No status
Development

No branches or pull requests

2 participants