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

docs: add <details> to the CONTRIBUTING.md to make some content visually shorter #952

Merged
merged 3 commits into from
Sep 30, 2024

Conversation

CommanderStorm
Copy link
Contributor

@CommanderStorm CommanderStorm commented Sep 27, 2024

During editing the contribution guide, I noticed that some parts of the contribution guide are likely not immediately necessary for all users. Let's hide some content (where it makes sense).

Rendered

What do you think about this?

@obi1kenobi
Copy link
Owner

Thanks for suggesting it, it's a good idea!

Details sections have a tendency to be "not obviously clickable" when considering a broad range of contributor skill levels, which in turn makes the contributing doc less contributor-friendly. I think with small tweaks, we can largely avoid this risk and end up with a better contributing file.

I don't like hiding the test output since it's necessary for people to see. I'd prefer we leave that out of a details section.

I'm open to using details blocks to hide the two troubleshooting items, but I'd prefer to add (click to expand) at the end of the summary line so as to minimize the risk of people not knowing how to use them.

@CommanderStorm
Copy link
Contributor Author

Reasonable, have changed as suggested ^^

CONTRIBUTING.md Outdated Show resolved Hide resolved
@obi1kenobi
Copy link
Owner

Thank you!

@obi1kenobi obi1kenobi enabled auto-merge (squash) September 30, 2024 18:52
@obi1kenobi obi1kenobi merged commit a12d1d4 into obi1kenobi:main Sep 30, 2024
32 checks passed
@CommanderStorm CommanderStorm deleted the shorter-contrib branch September 30, 2024 21:24
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