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

Feature: High contrast documentation #1623

Open
chanpl opened this issue Jul 26, 2024 · 2 comments
Open

Feature: High contrast documentation #1623

chanpl opened this issue Jul 26, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@chanpl
Copy link

chanpl commented Jul 26, 2024

Is your feature request related to a problem? Please describe.
faststream home page and documentation is hard to read for vision imparied.

Describe the solution you'd like
Make the home page and docs more easy to read for vision impaired, like the FastAPI docs. Perhaps a button to switch to high contrast doc is desirable for some people.

Describe alternatives you've considered
I think a simple solution like having high contrast background + text is good enough.

@chanpl chanpl added the enhancement New feature or request label Jul 26, 2024
@kumaranvpl
Copy link
Contributor

Hello @chanpl,

Sorry for your bad experience with faststream homepage. We will work on providing a better reading experience in the homepage.

We do provide darkmode and lightmode in faststream docs similar to fastapi docs
Screenshot from 2024-07-29 11-56-20
Screenshot from 2024-07-29 11-56-27

Below are the darkmode and lightmode from fastapi docs
Screenshot from 2024-07-29 11-56-02
Screenshot from 2024-07-29 11-56-10

Are you okay with our darkmode and lightmode implementation? Or do you like to have somethine else? Please let us know @chanpl

@kumaranvpl kumaranvpl self-assigned this Jul 29, 2024
@Lancetnik Lancetnik added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jul 30, 2024
@chanpl
Copy link
Author

chanpl commented Aug 1, 2024

@kumaranvpl Thank you very much for your positive response. The dark mode looks good to me :-) While the home page can be improved, but it's not a high priority.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

3 participants