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: improve accessibility of visualizations in engineering docs #173

Open
tgrecojs opened this issue Apr 27, 2024 · 7 comments
Open

docs: improve accessibility of visualizations in engineering docs #173

tgrecojs opened this issue Apr 27, 2024 · 7 comments
Assignees

Comments

@tgrecojs
Copy link
Contributor

While viewing the pages on an ipad i found myself unable to read the text inside the diagram shown within the engineering doc's provider service page.

Click the link above or navigate to: engineering docs > Akash Provider Operators > Provider Service and you'll see the view shown in the image below.

akash-visualization

feedback from others would be great as i'd like to ensure i'm not the only one who finds the text on the image difficult to read. there are tools for doing such analysis but not sure of them off the top of my head and would need to do some research.

i think modifying the images all together would be ideal but i am not sure what the timeline would be for something like that. @HoomanHQ what are your thoughts on implementing a modal, or some feature would would make it easy or users to see a zoomed-in version of the image? if we had that, then we could use it whenever images like the one above appear. Notes: this isn't the only instance where this occurs (look around engineering docs)

@HoomanHQ
Copy link
Collaborator

HoomanHQ commented Apr 27, 2024

agree: updating image is an ideal choice here (such issues are mostly in engineering docs, in user docs almost all the images are of ideal size and clearly visible).
maybe you can share some examples of docs that uses zoomed in features for images, we could definitely explore some ways..

@tgrecojs
Copy link
Contributor Author

tgrecojs commented Apr 27, 2024

Below is a screenshot from graphics i found on the general information page.

ss_04272024_000316

I feel as though updating the current graphics to make use of this color scheme would seemingly fix the issue. If we needed zoom functionality as well, then that's no problem, but I think that it would be beneficial to the network if these visualizations were modified to look like the one on that page i've linked to. In addition to being more accessible, i think it looks much more professional (for lack of a better term).

@brewsterdrinkwater what level of effort would it take to get such changes made to these images in the docs? i'm not sure of the total number of images that need updating but i don't think it'd be > 4-5.

@hiroyukikumazawa
Copy link
Contributor

I will solve this

@hiroyukikumazawa
Copy link
Contributor

hiroyukikumazawa commented May 2, 2024

https://drive.google.com/file/d/1yjg5E8xwgk1QBkQL-rVF2y5UKpJk1YbJ/view?usp=sharing
We can drop each frame as svg or image and integrate to our website.
How about this approach? @HoomanHQ

image

@hiroyukikumazawa
Copy link
Contributor

akash drawio
akash drawio (1)
akash drawio (2)
akash drawio (3)
akash drawio (4)

@HoomanHQ
Copy link
Collaborator

HoomanHQ commented May 2, 2024

Without over-complicating it.
The best approach here is to just modify the images based on the styling that we used in user docs following akash branding guidelines.

We will provide you the images and you can consider replacing them here.

thank you

@hiroyukikumazawa
Copy link
Contributor

How is it going?

HoomanHQ added a commit that referenced this issue May 15, 2024
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

No branches or pull requests

3 participants