Skip to content

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

Merged
merged 9 commits into from
Apr 1, 2025
Merged

Add accordion to faq. #1073

merged 9 commits into from
Apr 1, 2025

Conversation

nikoshell
Copy link
Contributor

@nikoshell nikoshell commented Mar 27, 2025

🖼️ Preview available 🖼️ : https://ep-website--1073.org.readthedocs.build/

@europython-society
Copy link
Member

europython-society commented Mar 27, 2025

Preview available

Key Value
url https://ep2025-faq.ep-preview.click
last update 2025-04-01T09:00:08.359Z

@nikoshell nikoshell requested a review from clytaemnestra March 27, 2025 10:52
@nikoshell
Copy link
Contributor Author

nikoshell commented Mar 27, 2025

#984, let's keep it open, I could miss understood issue.

@hypha
Copy link
Contributor

hypha commented Mar 27, 2025

hmmm how does it close #984? 🤔

@hypha
Copy link
Contributor

hypha commented Mar 27, 2025

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.

@nikoshell nikoshell requested a review from clytaemnestra March 27, 2025 17:36
@clytaemnestra
Copy link
Contributor

clytaemnestra commented Mar 27, 2025

  • Ctrl+F seems to work with the accordion as well - it opens automatically, so I think that's okay functionality-wise
  • I don't think it's closes #984 from the content perspective, as the accessibility page is not ready yet, but it provides a component that can be reused there and it does solve it from the technical side -> therefore, I'd keep #984 open so we don't forget to link the accessibility page to the FAQ

@clytaemnestra
Copy link
Contributor

@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?

@hypha
Copy link
Contributor

hypha commented Mar 27, 2025

Ctrl+F seems to work with the accordion as well - it opens automatically, so I think that's okay functionality-wise

Not for me on firefox.

Copy link
Contributor

@clytaemnestra clytaemnestra left a 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:

  1. The main purpose of the page is to help users find information
  2. We want to avoid having a wall of text: too long FAQ pages are unreadable
  3. 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.

@clytaemnestra
Copy link
Contributor

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/

@hypha
Copy link
Contributor

hypha commented Mar 28, 2025

what do you think about adding an Expand all and Close all button that’s clearly visible to users?

Was thinking the same. I reckon that should work. But might want to test how such a button behaves with a screen reader.

@nikoshell
Copy link
Contributor Author

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.
In current state of the website there are less accessible places than faq, so would be nice to start with main page.

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.

@clytaemnestra clytaemnestra merged commit 1517308 into ep2025 Apr 1, 2025
3 checks passed
@clytaemnestra clytaemnestra deleted the ep2025-faq branch April 1, 2025 09:00
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.

4 participants