Skip to content

Use <details> tag for real-world uses#4146

Closed
dstein64 wants to merge 1 commit intoxtermjs:masterfrom
dstein64:master
Closed

Use <details> tag for real-world uses#4146
dstein64 wants to merge 1 commit intoxtermjs:masterfrom
dstein64:master

Conversation

@dstein64
Copy link
Copy Markdown
Contributor

@dstein64 dstein64 commented Sep 25, 2022

This update puts the real-world use examples in a <details> tag so that it must be manually expanded.

The idea is to simplify the README.md page, for which the example real-world uses currently takes a large portion.

Is this a change you'd be interested in merging? If so, please let me know if there are any updates I should make.

The updated version can be viewed at:
https://github.com/dstein64/xterm.js/blob/master/README.md#real-world-uses

real_world_uses

Copy link
Copy Markdown
Member

@Tyriar Tyriar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would defeat a lot of the purpose of it being there as almost no one would expand and therefore we would get less PRs/engagement coming out way.

How about instead we just move it to the bottom, below releases/contributing and above license?

@dstein64
Copy link
Copy Markdown
Contributor Author

dstein64 commented Sep 26, 2022

"How about instead we just move it to the bottom, below releases/contributing and above license?"

Sure. I can make that update to this PR.

Would you be interested in any of the following as either part of or instead of the update to move the section:

  • Alphabetizing the list of examples (with a corresponding update to the Note, to mention ordering instead of "Please add any new contributions to the end of the list only")
  • Adding a <details> tag, like was originally proposed in this PR, but having it default to open, so that the list can optionally be collapsed

@Tyriar
Copy link
Copy Markdown
Member

Tyriar commented Sep 26, 2022

Alphabetizing the list of examples (with a corresponding update to the Note, to mention ordering instead of "Please add any new contributions to the end of the list only")

It was always "first come, first serve", so the earliest adopters are more prominently presented in the list. When alphabetizing, we would still want a select few at the top of the list, so the more important entries don't get buried and it gets a little complicated selecting those. Easiest it just to keep it as is

Adding a

Details tag, like was originally proposed in this PR, but having it default to open, so that the list can optionally be collapsed

I don't think there's much point adding interactivity like this at the bottom of a readme as it would rarely get clicked.

@dstein64 dstein64 closed this by deleting the head repository Sep 26, 2022
@dstein64
Copy link
Copy Markdown
Contributor Author

"Sure. I can make that update to this PR."

I made the update in a separate PR, moving the real-world uses section below releases/contributing and above license.
#4152

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants