-
Notifications
You must be signed in to change notification settings - Fork 65
Add accordion to faq. #1073
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
Add accordion to faq. #1073
Conversation
Preview available
|
#984, let's keep it open, I could miss understood issue. |
hmmm how does it close #984? 🤔 |
There was some discussion on this before. Making everything in the FAQ into accordion sure looks nice. But I don't think we know if it reduces functionality, because potentially, many users will prefer to Ctrl+F. This was the reason why I was thinking of only putting accordion to explain session types #989 for now. |
for more information, see https://pre-commit.ci
|
@hypha could you test it out and let me know if the search works for you as is? Or did you mean something else by it? |
Not for me on firefox. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did some research, and it turns out Ctrl+f doesn’t work in Firefox with the accordion component.
Taking a step back, let’s describe the problem we're trying to solve:
- The main purpose of the page is to help users find information
- We want to avoid having a wall of text: too long FAQ pages are unreadable
- We want to allow users to use Ctrl+f. I think that’s a very important feature for an FAQ page, since the whole point is to help people quickly find what they’re looking for
That said, I’d think how to satisfy all requirements, so it's functional, but also looks nice, whether we use accordion or something else.
An idea: @nikoshell, @hypha, what do you think about adding an Expand all and Close all button that’s clearly visible to users?
That way:
- if they’re on Firefox and want to search, they can expand everything first and then use Ctrl+f;
- if they're on Chrome/Safari/something else the search with work without having to use that button, so all good;
- if they don't need to search, they can skim through the questions and open the one they're interested in.
By the way, I tested the search box too, and it does find elements in Firefox.
Apparently GitHub was solving a similar issue, not sure if it's helpful, but leaving here for inspiration: https://github.blog/engineering/architecture-optimization/crafting-a-better-faster-code-view/ |
Was thinking the same. I reckon that should work. But might want to test how such a button behaves with a screen reader. |
If we consider accessibility we should use existing solutions which implements components with all goods to not invent the wheel again as we don't have so much resources. If we are able to decide which level of accessibility we wanna follow I will do that by default it will just affect time of features delivery. |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
🖼️ Preview available 🖼️ : https://ep-website--1073.org.readthedocs.build/